-
Notifications
You must be signed in to change notification settings - Fork 173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🙏 Help wanted: Deprecate old backend plugins #1176
Comments
This is a pretty good list of the backend plugins to start from: https://github.com/backstage/community-plugins/blob/main/docs/compatibility/new-backend-system.md |
ivangonzalezacuna
added a commit
to spreadshirt/backstage-plugin-s3
that referenced
this issue
Sep 9, 2024
ivangonzalezacuna
added a commit
to spreadshirt/backstage-plugin-s3
that referenced
this issue
Sep 9, 2024
I've started the work for Azure DevOps and Linguist: |
ivangonzalezacuna
added a commit
to spreadshirt/backstage-plugin-s3
that referenced
this issue
Sep 10, 2024
5 tasks
ivangonzalezacuna
added a commit
to spreadshirt/backstage-plugin-s3
that referenced
this issue
Sep 13, 2024
As described here: backstage/community-plugins#1176 Added a deprecation note in the readme as well, and links to the new docs in the deprecated types and methods.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
TL;DR make sure that
createRouter
and other exports are marked as deprecated. For the majority of packages there should only be one default export of the backend plugin itself. The@backstage/backend-common
package is deprecated so usages of that package should also be avoided.Backstage’s new backend system is ready for general use; we are now asking for a full transition over to the new backend system, which involves stop supporting the old system. By old system we mean having exports of
createRouter
and related types. There should only need to be one export like this in the backend plugin’sindex.ts
file.How do I help?
Run
yarn community-cli lint legacy-backend-exports workspaces/<workspace>
in the repository to get a full report of packages that require action.Phase 1
Ensure that plugins contain a default export
Ensure that there is a default export of the backend plugin in
index.ts
, see this example.If the plugin previously had a default export in
plugins/<plugin-id>/src/alpha.ts
, make sure that that export is deprecated and that the default export is moved to the non-alphaindex.ts
instead.Deprecate
createRouter
,RouterOptions
and similar types.Here’s an example of a plugin’s
createRouter
being deprecated./** + * @deprecated Please migrate to the new backend system as this will be removed in the future. * @public * */ export async function createRouter( options: RouterOptions, ): Promise<express.Router> {
Phase 2
Remove deprecated exports
Ensure that deprecations have been out for at one mainline release before proceeding with removal of all deprecated exports. Removing exports from one release to another is not recommended
The complete migration story for a backend plugin (including deprecation) is also mentioned in our docs.
If you take on migrating a backend plugin, feel free to add a comment in this issue to avoid duplicate work.
We plan to have all
createRouter
exports and@backstage/backend-common
usages removed by the end of this year. Your help would be much appreciated!The text was updated successfully, but these errors were encountered: