Skip to content

Commit

Permalink
docs: Improve RELEASE_HOWTO.md
Browse files Browse the repository at this point in the history
- Add copy-pastable snippets
- Document the tag creation process
  • Loading branch information
GeorgesStavracas committed Feb 13, 2025
1 parent d9bca63 commit 451daba
Showing 1 changed file with 55 additions and 5 deletions.
60 changes: 55 additions & 5 deletions RELEASE_HOWTO.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,59 @@
# Steps for doing a xdg-desktop-portal release

### Prepare the release

- Make sure the version in `meson.build` is correct
- Create a branch
```sh
$ git checkout -b release-${version}
```
- Update translations
```sh
$ ninja -C ${builddir} xdg-desktop-portal-update-po
$ git commit -m "Update translations"
```
- Add your changelog to the `NEWS.md` file
- Run the "Release new version" GitHub Action
- The options are taken from the last `NEWS.md` entry by default, you may override them if needed
- Bump version in `meson.build`
- Update `SECURITY.md` if this is a new stable release
- Update `.github/ISSUE_TEMPLATE/bug-report.yml` if this is a new stable release
```sh
$ git add NEWS.md
$ git commit -m ${version}
```
- Push your branch
```sh
$ git push -u ${fork} release-${version}
```
- Open a pull request

### Create a Signed Tag

**NOTE**: Only project maintainers can create a tag.

Make sure that:
- You're on the `main` branch, or a stable branch;
- The tip of the branch is a release commit (e.g. `1.19.4`)
- The version in `meson.build` is correct

Then create the tag:

```sh
$ git evtag sign ${version}
$ git push -u origin ${version}
```

### Post-Release

- Update version number in `meson.build` to the next release version
- Start a new section in `NEWS.md`
```md
Changes in ${nextVersion}
=================
Released: Not yet
...
```

### Post-Branching

After creating a stable branch:

- Update version number in `meson.build` to the next unstable release version
- Update `SECURITY.md`
- Update `.github/ISSUE_TEMPLATE/bug-report.yml`

0 comments on commit 451daba

Please sign in to comment.