Skip to content

Commit

Permalink
Update HOWTO-RELEASE.md regarding auto_tag_stable.yml
Browse files Browse the repository at this point in the history
Update the procedure to update the workflow that automatically refreshes the "stable" tag from commits in the current release branch.
  • Loading branch information
rouault committed Nov 16, 2024
1 parent 863a75e commit a2fe0c6
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions HOWTO-RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,31 @@ Barring a successful promotion process we can proceed with the final release.

See step 1.6 above. Do not rename the archives with RC postfixes.

### 2.2 Update website

### 2.2 Update auto_tag_stable.yml workflow

a) Remove the .github/workflows/auto_tag_stable.yml from the now old maintenance
branch. That is if releasing x.y, remove it from x.(y-1)

```sh
git checkout x.y-1
cp .github/workflows/auto_tag_stable.yml /tmp
git rm .github/workflows/auto_tag_stable.yml -m "Remove obsolete auto_tag_stable.yml workflow"
git push origin x.y-1
```

b) Create auto_tag_stable.yml workflow in the new branch

```sh
git checkout x.y
cp /tmp/auto_tag_stable.yml .github/workflows/auto_tag_stable.yml
sed -i "s/x.y-1/x.y/" .github/workflows/auto_tag_stable.yml # Update the branch
git add .github/workflows/auto_tag_stable.yml
git commit .github/workflows/auto_tag_stable.yml -m "Add auto_tag_stable.yml"
git checkout master
```

### 2.3 Update website

- Add the release notes from `NEWS.md` to `docs/source/news.rst`

Expand All @@ -165,7 +189,7 @@ See step 1.6 above. Do not rename the archives with RC postfixes.

When pushed upstream the website will be update to the current version.

### 2.3 Tag the release
### 2.4 Tag the release

Tag the release with:

Expand All @@ -174,21 +198,21 @@ git tag -a -m "Create tag x.y.z" x.y.z
git push --tags
```

### 2.4 Check the GitHub Zeonodo integration
### 2.5 Check the GitHub Zeonodo integration

Go to https://zenodo.org/account/settings/github/ and check that the OSGeo/PROJ
repository is ON so that the creation of the GitHub release triggers the
creation of a corresponding Zenodo record.

### 2.5 Prepare the release on GitHub
### 2.6 Prepare the release on GitHub

When the new tag is pushed upstream GitHub picks up that a new release has been
issued. Update the new release on <https://github.com/OSGeo/PROJ/releases> with
the release notes from `NEWS.md` and add the prepared source distribution archives
to the release (otherwise GitHub will just package the entire repository - we
don't want that).

### 2.6 Announce the new release
### 2.7 Announce the new release

The release should be announced on PROJ and MetaCRS mailing lists. Additionally
the release announcement should be sent to <[email protected]> which will add
Expand Down

0 comments on commit a2fe0c6

Please sign in to comment.