How to deprecate a repository: a checklist

The checklist#

1. 1

   Find dependents

   Use GitHub's dependency graph and code search for the package or repository name. Check CI and deploy configuration.

2. 2

   Choose a replacement

   Write the migration steps.

3. 3

   Announce

   Add a README banner, final release notes, and a package registry deprecation notice.

4. 4

   Stop new use

   Disable new issues or point them to the replacement.

5. 5

   Set a date and keep it

   Give dependents a clear window.

6. 6

   Archive the repository

   GitHub archiving makes it read-only. See GitHub Docs, Archiving repositories.

7. 7

   Leave a pointer

   Keep docs or a redirect that names the successor.