Skip to content

Commit 71c85a5

Browse files
authored
docs: add RELEASING instructions (#178)
These have been split off from the main releasing process over at dagger/dagger. Signed-off-by: Justin Chadwell <[email protected]>
1 parent e47aba4 commit 71c85a5

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

RELEASING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Releasing
2+
3+
This describes how to release `dagger-for-github`.
4+
5+
The action's `README.md` and `action.yml` should be relatively evergreen now,
6+
so we don't need to bump with Dagger releases anymore, just if there is a fix
7+
to `dagger-for-github`. We'll use `8.0.0` style versions for the action going
8+
forward to comply with GitHub immutable actions standards. Should not need
9+
separate `v8` tag. Should automatically get `v8`, `v8.0`, `v8.0.0` as well as
10+
`8.0.0` resolved by GitHub.
11+
12+
## Let the team know
13+
14+
- [ ] When preparing a release (as mentioned in `dagger/dagger`'s
15+
[`RELEASING.md`](https://github.com/dagger/dagger/blob/main/RELEASING.md),
16+
include whether there should be a new `dagger-for-github` release as well.
17+
18+
- [ ] Take a peek at the action or mention it in the release thread on Discord
19+
to determine if there are updates to reflect in the docs.
20+
21+
- [ ] Create/push a new patch tag for fixes/changes to `dagger-for-github`
22+
23+
```console
24+
# Find the latest released patch https://github.com/dagger/dagger-for-github/releases
25+
# or via the `gh` CLI. Use that to figure out the NEXT_PATCH_VERSION.
26+
gh release view --repo dagger/dagger-for-github --json tagName,publishedAt
27+
28+
# Sign the tag, using the date as the comment, e.g. 2024-07-22
29+
git tag --sign -m $(date '+%Y-%m-%d') <NEXT_PATCH_VERSION>
30+
git push origin <NEXT_PATCH_VERSION> #shouldn't need to force since new tag
31+
```
32+
33+
- [ ] Create a new release from the patch tag (auto-fill release notes via the
34+
GitHub UI or via the `gh` CLI)
35+
- [ ] Submit PR to change the version mentioned in Dagger docs. See example [here](https://github.com/dagger/dagger/pull/9705/files)
36+
37+
```console
38+
# --verify-tag will ensure the last tag creation step was done
39+
gh release create --generate-notes --verify-tag <NEXT_PATCH_VERSION>
40+
```

0 commit comments

Comments
 (0)