Skip to content
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

deprecate annotations package #627

Closed
tomwayson opened this issue Sep 8, 2021 · 1 comment · Fixed by #654
Closed

deprecate annotations package #627

tomwayson opened this issue Sep 8, 2021 · 1 comment · Fixed by #654

Comments

@tomwayson
Copy link
Member

Annotations are being replaced by discussions.

We have not added any features to annotations for many months, it's essentially in maintenance mode. Yet, new versions are released regularly b/c we don't use lerna's independent versioning (that's a subject for another issue).

We're also planning on consolidating other packages in #306 so I think it's a good idea to establish a pattern for how we deprecate a package. Mainly I want to get the deprecated code out of our build, test, and publish pipelines. Of course we could just delete the package, but I think it would be better to move the package's source code out of the packages folder and into a new root-level folder (i.e. deprecated) w/in the monorepo. This will prevent the tooling from building/testing/releasing the package with the others, but still allow us to easily review the old source code, or make maintenance updates if needed.

Additionally, we should:

  • add a deprecation message to package README
  • cut one final release w/ ^^^
  • mark the package as deprecated in the npm registry
@tomwayson
Copy link
Member Author

tomwayson commented Sep 30, 2021

it's a good idea to establish a pattern for how we deprecate a package

In #654 I added a Deprecated Packages section of the README that can link to the last commit that had that package, so that we can have easy access to the source code and safely remove the files from master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant