diff --git a/doc/howto_release.md b/doc/howto_release.md index a1c14071c9a..1b65ecab976 100644 --- a/doc/howto_release.md +++ b/doc/howto_release.md @@ -33,12 +33,13 @@ git diff git diff --staged # Should give no output: git log upstream/releasebranch_8_3..HEAD -# Should give the same as last commits visible on GitHub: +# There should be no commits which are not visible on GitHub: git log --max-count=5 ``` -Now you can merge (or rebase) updates from the remote your local branch -and optionally update your own fork: +Now you can rebase updates from the remote your local branch. +Above, you confirmed you have no local commits, so this should happen +without rebasing any local commits, i.e., it should just add the new commits: ```bash git merge upstream/releasebranch_8_3 && git push origin releasebranch_8_3 @@ -49,14 +50,16 @@ Verify the result: ```bash # Should give no output: git log upstream/releasebranch_8_3..HEAD -# Should give the same as last commits visible on GitHub: +git log HEAD..upstream/releasebranch_8_3 +# Should give exactly the same as last commits visible on GitHub: git log --max-count=5 ``` -Now or any time later, you can use `git log` and `git show` to see the latest -commits and the last commit including the changes. +Now or any time later, you can use `git status`, `git log`, and `git show` +to see a branch, latest commits and a last commit including the changes. ```bash +git status git log --max-count=5 git show ``` @@ -410,51 +413,65 @@ Release is done. ## Improve release description -For final releases only, go to Zenodo.org a get a Markdown badge for the release -which Zenodo creates with a DOI for the published release. +For final releases only, go to [Zenodo](https://doi.org/10.5281/zenodo.5176030) +and get a Markdown badge for the release which Zenodo creates with a DOI +for the published release. For all releases, click the Binder badge to get Binder to build. Use it to test it and to cache the built image. Add more links to (or badges for) more notebooks if there are any which show well specific features added or updated in the release. -## Create entries for the new release - -### Trac Wiki release page entry +## Create various entries for the new release -Add entry in +### Cron jobs -### Update Hugo web site and other pages to show the new version +Only in case of major releases: -For a (final) release (not release candidate), write announcement and publish it: +- update '[cronjob(s)](https://github.com/OSGeo/grass-addons/tree/grass8/utils/cronjobs_osgeo_lxd/)' + on grass.osgeo.org to next but one release tag for the differences -- News section, +### Update Hugo web site -Increment the GRASS GIS version in +Update website only for final releases (not release candidates). Submit the changes +in a single PR. -- -- - -Update the version in the Wiki page: - -Subsequently, verify the software pages: +Software pages: - Linux: - Windows: - Mac: +- Releases: +- Website variables: -### Only in case of new major release +Write announcement and publish it: -- update '[cronjob(s)](https://github.com/OSGeo/grass-addons/tree/grass8/utils/cronjobs_osgeo_lxd/)' - on grass.osgeo.org to next but one release tag for the differences -- wiki updates, only when new major release: +- News section: + +### GRASS Wiki + +For final releases (not release candidates), update the last version +on the main page: + +- Wiki: + +- For major release only: - {{cmd|xxxx}} macro: - - update last version on main page + +### Trac wiki + +For all releases: + +- Add link to GitHub release page to + +For major and minor releases: + - Add trac Wiki Macro definitions for manual pages G8X:modulename - Edit: -## Packaging notes -### WinGRASS notes +## WinGRASS notes + +For new branches and final releases (see additional instructions in the repo): - Go to - Update grass_packager_release.bat, eg. @@ -477,11 +494,6 @@ Subsequently, verify the software pages: copy_addon 830RC1 8.3.0RC1 ``` -### Ubuntu Launchpad notes - -- Create milestone and release: -- Upload tarball for created release - ### Update grass.osgeo.org These updates are for final releases only. @@ -506,12 +518,12 @@ Add release to history page: ## Tell others about release -- If release candidate (send just a short invitation to test): - - +- If release candidate (just a short invitation to test): - + - -If final release, send out an announcement (press release) which is a shortened -version of release desciption and website news item (under `/announces/`). +If final release, send out an announcement (press release) +which is a shortened version of release desciption and website news item. Note: Do not use relative links. - Our main mailing lists: @@ -519,8 +531,8 @@ Note: Do not use relative links. (ask a development coordinator to be added) - | - | -- OSGeo.org: , (send an email, then it - will be approved) +- OSGeo.org: , + (send an email, then it will be approved) Via web and social media: