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

Document how is the release process #17

Open
humitos opened this issue Nov 24, 2022 · 2 comments
Open

Document how is the release process #17

humitos opened this issue Nov 24, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@humitos
Copy link
Member

humitos commented Nov 24, 2022

Merging #16 will make us to do a release of the v1 again. We want to follow what we talked at #5 (comment)

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 humitos added the documentation Improvements or additions to documentation label Nov 24, 2022
@humitos
Copy link
Member Author

humitos commented Jan 30, 2023

The procedure is more or less the following:

  • versions are tagged via git using semver v1.0, v1.1, etc
  • each major version always point to the latest minor version: in our current case v1 and v1.1 points to exactly the same commit hash
  • next time, when we release v1.2, we will need to re-tag v1 to point to that new commit hash
  • this is done by deleting the old git tag (git push --delete origin v1) and re-tagging it (git tag v1 <new hash>)
  • when a major change is done, we need to tag it as v2 and v2.0
  • the release/v<major> branch has to be rebased with the changes from origin/main

@LecrisUT
Copy link

LecrisUT commented Jun 8, 2023

* 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?

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

No branches or pull requests

2 participants