readthedocs / actions

GitHub Actions for Read the Docs
MIT License
33 stars 10 forks source link

Document how is the release process #17

Open humitos opened 1 year ago

humitos commented 1 year ago

Merging #16 will make us to do a release of the v1 again. We want to follow what we talked at https://github.com/readthedocs/actions/issues/5#issuecomment-1197688541

This basically means re-tagging v1 to point to the latest commit that includes the single-version option.

Since this release process is no the common for other repositories, we need to document it in a clear way, so it's easy to follow.

humitos commented 1 year ago

The procedure is more or less the following:

LecrisUT commented 1 year ago
* this is done by deleting the old git tag (`git push --delete origin v1`) and re-tagging it (`git tag v1 <new hash>`)

This should be handled by GH workflow, seems rather straightforward to implement with appropriate regex to avoid recursive calls. How about latest tag as well?