š [Help Wanted] Clean up deprecations
See original GitHub issueThe Backstage CLI providers the repo list-deprecations
command to list all usages of deprecated symbols. We have a lot of these in the main repo, and would like to clean them up. I think this is a good first issue for anyone that wants to get involved in the project and help out.
Steps
- Run the following command in the project root:
yarn backstage-cli repo list-deprecations
- You will not get a long list of deprecated usages, looking something like this:
...
packages/backend-common/src/reading/index.ts:19:10 - 'BitbucketUrlReader' is deprecated. in favor of BitbucketCloudUrlReader and BitbucketServerUrlReader
packages/backend-common/src/reading/index.ts:19:10 - 'BitbucketUrlReader' is deprecated. in favor of BitbucketCloudUrlReader and BitbucketServerUrlReader
...
- Pick a couple of related deprecations to fix, not too many at once, but be sure to for example fix all deprecations in a single file at the same time. Generally the deprecation message should provide guidance for how to migrate. If thatās not the case, please chime in this issue so that we can help clarify an perhaps improve the deprecation message. Note that the deprecated symbols themselves should not be removed, we donāt want to change the API surface at this stage.
Issue Analytics
- State:
- Created 10 months ago
- Comments:19 (17 by maintainers)
Top Results From Across the Web
Issues | Help Wanted - Ember.js
Issues that could use your help! ; Document how to update arrays and objects in Ember Octane. #1539 ; Cleanup deprecations in guidemaker-ember-template....
Read more >Clean up yamllint warnings and errors in deprecation yamls (!81964 ...
Clean up yamllint warnings and errors in deprecation yamls ... These are strongly recommended to assist reviewers and reduce the time to merge...
Read more >2022.9: Home Assistant Birthday Release!
New revamped Automation Editor, Weekly Schedule helper to help with automations, and Paul Bottein (Mushroom Cards) joins Nabu Casa.
Read more >Trash Cleanup Jobs, Employment in Phoenix, AZ | Indeed.com
27 Trash Cleanup jobs available in Phoenix, AZ on Indeed.com. Apply to Specialist, Dishwasher, Forklift Operator and more!
Read more >OpenEthereum is Deprecated (@OpenEthereumOrg) / Twitter
12/ The usefulness has run its course, and we look forward to the next phase of clean, green and massively scalable blockchain infrastructure...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Big thank you to everyone that has been helping out so far! š
I wanted to highlight something thatās been a somewhat common confusion, which is that we donāt want to remove the deprecated symbols themselves, including any re-exports of them and so on. There are also cases where a deprecated symbol depends on another deprecated symbol, in which case thereās no need to change the usage. The main guideline here is that we donāt want the public API of any of the packages to change at this point. When running
yarn build:api-reports
there should be no changes to any of theapi-report.md
files.@Znarvl please continue! I only have one commit with 6 files changed. I want to learn more about how tech-docs works so I will focus on
plugins/techdocs
.