How do you decommission a GitHub project?

635 Views Asked by At

An organization I work with has a project on GitHub that no one outside the organization has used and we are end-of-lifeing it.

I see there is a great big delete button, but I wonder if there is a way to freeze the project so it can never be pushed to again, and write "decommissioned" on it in some way that will be universally recognized by other programmers.

2

There are 2 best solutions below

1
On BEST ANSWER

First off, simply add an explanatory note at the beginning of the README.md file in the repo (and if that file doesn't exist yet, add it). Say something like "This project has reached its end of life, and is now just preserved here for posterity."

The non-enterprise flavor of GitHub doesn't let you disable push, unfortunately.

0
On

In addition of a README, you can make sure the number of people able to push back to the project is minimal (ideally one, the owner, and 0 contributors)

That way, nobody is able to push back to the repo, and any new fork would include the README announcing the eol.