Skip to content

Commit

Permalink
clarify release instructions (libjxl#3820)
Browse files Browse the repository at this point in the history
(cherry picked from commit 33f7c03)
  • Loading branch information
mo271 committed Nov 26, 2024
1 parent aaacb01 commit 72b7ba2
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions doc/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,15 @@ branches](https://docs.github.com/en/github/administering-a-repository/defining-
in our repository, however you can push to a protected branch when *creating* it
but you can't directly push to it after it is created. To include more changes
in the release branch see the "Cherry-picking fixes to a release" section below.
Remember to tag the first commit in the `main` branch after the branch of point
with the suffix `-snapshot`, so for instances, if you just made the
branch `v0.5.x`, run
```
git checkout [hash of first commit after the branch off point]
git tag v0.5-snapshot
git push git@github.com:libjxl/libjxl.git v0.5-snapshot
```


## Creating a merge label

Expand Down Expand Up @@ -274,17 +283,29 @@ instructions:
the release itself that are not included in the CHANGELOG.md, although prefer
to include those in the CHANGELOG.md file. You can switch to the Preview tab
to see the results.
* Copy-paste the following note:
```markdown
**Note:** This release is for evaluation purposes and may contain bugs, including security bugs, that may not be individually documented when fixed. See the [SECURITY.md](SECURITY.md) file for details. Always prefer to use the latest release.

Please provide feedback and report bugs [here](https://github.com/libjxl/libjxl/issues).
```


* Finally click "Publish release" and go celebrate with the team. 🎉

* The branch v0.7.x will be pushed to gitlab automatically, but make sure to
manually push the *tag* of the release also to
https://gitlab.com/wg1/jpeg-xl, by doing
https://gitlab.com/wg1/jpeg-xl, by doing configuring `gitlab` to be the remote `git@gitlab.com:wg1/jpeg-xl.git` and then running:

```bash
git push gitlab v0.7.1
```
where `gitlab` is the remote `git@gitlab.com:wg1/jpeg-xl.git`.
and possibly also push the tag for the snapshot to gitlab, if it wasn't done yet:
```bash
git push gitlab v0.7-snapshot
```



### How to build downstream projects

Expand Down

0 comments on commit 72b7ba2

Please sign in to comment.