question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. ItĀ collects links to all the places you might be looking at while hunting down a tough bug.

And, if youā€™re still stuck at the end, weā€™re happy to hop on a call to see how we can help out.

šŸ™ [Help Wanted] Clean up deprecations

See original GitHub issue

The 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

  1. Run the following command in the project root:
yarn backstage-cli repo list-deprecations
  1. 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
...
  1. 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:open
  • Created 10 months ago
  • Comments:19 (17 by maintainers)

github_iconTop GitHub Comments

3reactions
Rugvipcommented, Nov 23, 2022

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 the api-report.md files.

1reaction
kurtakingcommented, Nov 22, 2022

@kurtaking dang Iā€™ve been working on a fix for cost-insights now and are nearly done, didnā€™t think this issue would have so much traffic at once. How far have you come?

@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.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found