doc: update howto_release.md to release_branch#2707
doc: update howto_release.md to release_branch#2707neteler wants to merge 6 commits intoOSGeo:releasebranch_8_2from neteler:doc_howto_release_fixes
Conversation
This PR - adds release branch parameter to `git` calls - changes hardcoded version to `$VERSION` - adds some comments TODO: how to enforce the right release branch?
doc/howto_release.md
Outdated
| Now push the tag upstream - this will trigger the automated workflows linked to tags: | ||
|
|
||
| ```bash | ||
| # TODO: how to enforce the right release branch? |
There was a problem hiding this comment.
@wenzeslaus How does the tag magic work for release_branch_8_2? With git push upstream I guess it would land in main and not the branch...
There was a problem hiding this comment.
The tag is made on the branch - a specific commit actually - not pushed to the branch, so what matters is the git tag step.
...work for
release_branch_8_2...
BTW, do you want to name next release branch release_branch_8_3, not releasebranch_8_3? :-)
There was a problem hiding this comment.
The tag is made on the branch - a specific commit actually - not pushed to the branch, so what matters is the
git tagstep.
Yes, I see (still learning this part of git). From related the SO answer which you indicated I read:
Specifying a branch name as the tag target defaults to that branch's most recent commit; e.g.:
git tag v0.1.0 develop # tags HEAD of 'develop' branch
(As others have noted, you can also specify a commit ID explicitly as the tag's target.)
So this should translate into
git tag v7.8.8RC3 releasebranch_8_2 # tags HEAD of 'releasebranch_8_2' branch
... right? But then push to where?
(Importantly, the instructions here shall become fail-safe to also be able to successfully release even when tired ;-) )
There was a problem hiding this comment.
BTW, do you want to name next release branch release_branch_8_3, not releasebranch_8_3? :-)
Sorry, typo...
doc/howto_release.md
Outdated
| Now push the tag upstream - this will trigger the automated workflows linked to tags: | ||
|
|
||
| ```bash | ||
| # TODO: how to enforce the right release branch? |
There was a problem hiding this comment.
The tag is made on the branch - a specific commit actually - not pushed to the branch, so what matters is the git tag step.
...work for
release_branch_8_2...
BTW, do you want to name next release branch release_branch_8_3, not releasebranch_8_3? :-)
| git show | ||
| git diff |
There was a problem hiding this comment.
This is very different. Maybe you want both? git show shows last commit. git diff shows uncommitted changes in tracked files.
| Push the tag to the upstream repo: | ||
| Push the tag to the upstream repo, release branch: | ||
|
|
||
| ```bash | ||
| git push upstream | ||
| git push upstream releasebranch_8_2 |
There was a problem hiding this comment.
This is pushing the commits on the release branch. I'm not sure about the tag, probably not. I don't know why this says tag actually. There is no tag created above, so I guess I copy-pasted some other text.
There was a problem hiding this comment.
This is where I recently messed it up (I tried to use this procedure for the G78 RC3 release but failed).
|
This SO question seems to cover the tag and branch topic well: Do Git tags only apply to the current branch? |
|
Needed: partial sync to #2414 |
- partial sync to document version in `main` - markdown linting fixes - some outdated version numbers updated - fix path to helper script - Use subsections; add Publish release section - osgeo8-grass -> osgeo7-grass - Merge in improvements from #2707 (replaces #2707) - Attempt to merge in improvements from #2414 Note: PRs for the other branches will be created separately (do not back-/forward-port this PR).
- markdown cosmetics and some outdated version numbers updated. - fix path to helper script - Use subsections; add Publish release section - osgeo8-grass -> osgeo7-grass - Merge in improvements from #2707 (replaces #2707) - Attempt to merge in improvements from #2414 Note: PRs for the release branches will be created separately (do not forward-port this PR).
Markdown cosmetics and some outdated version numbers updated. * Use subsections; add Publish release section * osgeo8-grass -> osgeo7-grass * Merge in improvements from OSGeo#2707 (replaces OSGeo#2707) * Attempt to merge in improvements from OSGeo#2414
Markdown cosmetics and some outdated version numbers updated. * Use subsections; add Publish release section * osgeo8-grass -> osgeo7-grass * Merge in improvements from OSGeo#2707 (replaces OSGeo#2707) * Attempt to merge in improvements from OSGeo#2414
2 participants
Changes of this PR:
fixes:
git difftogit showgenerate_release_notes.pyTODO: how to enforce the correct release branch in
git push upstreamstep?enhancements:
gitcalls$VERSIONTODO after merge: fwd-port fixes in this PR to
main.