Skip to content

Commit 0fa10b2

Browse files
committed
Update releasing guide
1 parent 6cec5d4 commit 0fa10b2

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

RELEASING.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Gradle GitHub Actions release process
22

33
## Preparation
4-
- Push any outstanding changes to branch main. For any change that impacts the released action, you must run npm via `./build all` and commit the various files generated into the dist directory.
4+
- Push any outstanding changes to branch main.
55
- Check that https://github.com/gradle/actions/actions is green for all workflows for the main branch.
6+
- This should include any workflows triggered by `[bot] Update dist directory`
67
- Decide on the version number to use for the release. The action releases should follow semantic versioning.
78
- By default, a patch release is assumed (eg. `3.0.0``3.0.1`)
89
- If new features have been added, bump the minor version (eg `3.1.1``3.2.0`)
@@ -11,14 +12,12 @@
1112

1213
## Release gradle/actions
1314
- Create a tag for the release. The tag should have the format `v3.1.0`
14-
- From CLI: `git tag v3.1.0`
15-
- Push the commit and tag
16-
- From CLI: `git push --tags`
15+
- From CLI: `git tag v3.1.0 && git push --tags`
1716
- Go to https://github.com/gradle/actions/releases and "Draft new release"
1817
- Use the newly created tag and copy the tag name exactly as the release title.
1918
- Craft release notes content based on issues closed, PRs merged and commits
2019
- Include a Full changelog link in the format https://github.com/gradle/actions/compare/v2.12.0...v3.0.0
21-
- Publish the release. Before using "Publish release", check that [action workflows](https://github.com/gradle/actions/actions) are green for the version tag. eg https://github.com/gradle/actions/actions?query=branch%3Av3.0.0
20+
- Publish the release.
2221
- Force push the `v3` tag (or current major version) to point to the new release. It is conventional for users to bind to a major release version using this tag.
2322
- From CLI: `git tag -f -a -m "v3.0.0" v3 v3.0.0 && git push -f --tags`
2423
- Note that we set the commit message for the tag to the newly released version.
@@ -38,6 +37,21 @@ During the 3.x release series, we will continue to publish parallel releases of
3837
- Force push the `v3` tag (or current major version) to point to the new release.
3938
- From CLI: `git tag -f -a -m "v3.0.0" v3 v3.0.0 && git push -f --tags`
4039

40+
## Release gradle/wrapper-validation-action
41+
42+
During the 3.x release series, we will continue to publish parallel releases of `gradle/wrapper-validation-action`. These releases will simply delegate to `gradle/actions/wrapper-validation` with the same version.
43+
44+
- Update the [wrapper-validation-action action.yml](https://github.com/gradle/wrapper-validation-action/blob/main/action.yml#L162) file to point to the newly released version of `gradle/actions/wrapper-validation`.
45+
- Ensure that any parameters that have been added to the `wrapper-validation` action (if any) are added to the action definition, and that these are passed on to setup-gradle.
46+
- Create and push a tag for the release.
47+
- From CLI: `git tag v3.1.0 && git push --tags`
48+
- Go to https://github.com/gradle/wrapper-validation-action/releases and "Draft new release"
49+
- Use the newly created tag and copy the tag name exactly as the release title.
50+
- In the release notes, point users to the gradle/actions release. Include a header informing users to switch to `gradle/actions/wrapper-validation`.
51+
- Publish the release.
52+
- Force push the `v3` tag (or current major version) to point to the new release.
53+
- From CLI: `git tag -f -a -m "v3.0.0" v3 v3.0.0 && git push -f --tags`
54+
4155
## Post release steps
4256

4357
Submit PRs to update the GitHub starter workflow. Starter workflows contain content that should reference the Git hash of the current gradle/actions release:

0 commit comments

Comments
 (0)