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

docs: Update the release guide for creating/pushing tags #3127

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rnishtala-sumo
Copy link
Contributor

@rnishtala-sumo rnishtala-sumo commented Jun 30, 2023

Update the release guide for creating/pushing tags

  • Release guide change to avoid tags from being created on main and instead only create tags on release branches.

  • Documentation updated

@github-actions github-actions bot added the documentation documentation label Jun 30, 2023
@rnishtala-sumo rnishtala-sumo marked this pull request as ready for review July 5, 2023 22:03
@rnishtala-sumo rnishtala-sumo requested a review from a team as a code owner July 5, 2023 22:03
Copy link
Contributor

@sumo-drosiek sumo-drosiek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to tag a release branch (with major releases), as git hash is going to give us wrong value if it won't be on main branch.

This is quite painful and not intuitive that the release branch has already additional commit which is not tagged, but at least CI and builds are being created properly

@rnishtala-sumo
Copy link
Contributor Author

I didn't think that git hash depended on a branch. Just did a quick search on this and this popped up.

A commit hash depends on

  • The commit message
  • The file changes
  • The commit author (and committer- they can be different)
  • The date
  • The parent commit hash

As long as we have the correct list of commits in the release branch, it seems like we should be able to push a tag on this branch and create a release, irrespective of major, minor or patch?

@sumo-drosiek
Copy link
Contributor

sumo-drosiek commented Jul 6, 2023

Oh, sorry, I meant git describe:

> git describe --tags              
v3.9.1-7-gd373d1ca

it relies on commits history, so if we tag outside of branch, we always get v3.9.1-...

@rnishtala-sumo
Copy link
Contributor Author

yes that's true, so all the patch release tags would be on the release branch and all the major/minor release tags would go on the main branch.

@sumo-drosiek
Copy link
Contributor

yes that's true, so all the patch release tags would be on the release branch and all the major/minor release tags would go on the main branch.

Yes, exactly

@sumo-drosiek
Copy link
Contributor

@rnishtala-sumo can we close it?

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

Successfully merging this pull request may close these issues.

None yet

2 participants