Files
backstage/plugins/techdocs-backend/CHANGELOG.md
T
github-actions[bot] bc0f47b7b7 Version Packages
2020-11-19 15:13:57 +00:00

3.3 KiB

@backstage/plugin-techdocs-backend

0.2.1

Patch Changes

0.2.0

Minor Changes

  • 6d29605db: Change the default backend plugin mount point to /api

  • 5249594c5: Add service discovery interface and implement for single host deployments

    Fixes #1847, #2596

    Went with an interface similar to the frontend DiscoveryApi, since it's dead simple but still provides a lot of flexibility in the implementation.

    Also ended up with two different methods, one for internal endpoint discovery and one for external. The two use-cases are explained a bit more in the docs, but basically it's service-to-service vs callback URLs.

    This did get me thinking about uniqueness and that we're heading towards a global namespace for backend plugin IDs. That's probably fine, but if we're happy with that we should leverage it a bit more to simplify the backend setup. For example we'd have each plugin provide its own ID and not manually mount on paths in the backend.

    Draft until we're happy with the implementation, then I can add more docs and changelog entry. Also didn't go on a thorough hunt for places where discovery can be used, but I don't think there are many since it's been pretty awkward to do service-to-service communication.

  • 5a920c6e4: Updated naming of environment variables. New pattern [NAME]_TOKEN for Github, Gitlab, Azure & Github enterprise access tokens.

    Detail:

    • Previously we have to export same token for both, catalog & scaffolder
    export GITHUB_ACCESS_TOKEN=foo
    export GITHUB_PRIVATE_TOKEN=foo
    

    with latest changes, only single export is sufficient.

    export GITHUB_TOKEN=foo
    export GITLAB_TOKEN=foo
    export GHE_TOKEN=foo
    export AZURE_TOKEN=foo
    

    list:

    Old name New name
    GITHUB_ACCESS_TOKEN GITHUB_TOKEN
    GITHUB_PRIVATE_TOKEN GITHUB_TOKEN
    GITLAB_ACCESS_TOKEN GITLAB_TOKEN
    GITLAB_PRIVATE_TOKEN GITLAB_TOKEN
    AZURE_PRIVATE_TOKEN AZURE_TOKEN
    GHE_PRIVATE_TOKEN GHE_TOKEN

Patch Changes