Skip to content

Commit 71ffd62

Browse files
committed
misc: Add release HOWTO and update NEWS
1 parent 6ed8dc1 commit 71ffd62

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

NEWS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
Changes in 0.2.0
2+
=================
3+
Released: Not yet
4+
5+
16
Changes in 0.1.0
27
=================
38
Released: 2025-03-26

RELEASE_HOWTO.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Steps for doing a xdg-native-messaging-proxy release
2+
3+
### Prepare the release
4+
5+
- Make sure the version in `meson.build` is correct
6+
- Create a branch
7+
```sh
8+
$ git checkout -b release-${version}
9+
```
10+
- Add your changelog to the `NEWS.md` file
11+
```sh
12+
$ git add NEWS.md
13+
$ git commit -m ${version}
14+
```
15+
- Push your branch
16+
```sh
17+
$ git push -u ${fork} release-${version}
18+
```
19+
- Open a pull request
20+
21+
### Create a Signed Tag
22+
23+
**NOTE**: Only project maintainers can create a tag.
24+
25+
Make sure that:
26+
- You're on the `main` branch, or a stable branch;
27+
- The tip of the branch is a release commit (e.g. `1.19.4`)
28+
- The version in `meson.build` is correct
29+
30+
Then create the tag:
31+
32+
```sh
33+
$ git evtag sign ${version}
34+
$ git push -u origin ${version}
35+
```
36+
37+
### Post-Release
38+
39+
- Update version number in `meson.build` to the next release version
40+
- Start a new section in `NEWS.md`
41+
```md
42+
Changes in ${nextVersion}
43+
=================
44+
Released: Not yet
45+
...
46+
```

0 commit comments

Comments
 (0)