@@ -7,15 +7,58 @@ inputs:
77 gpg_passphrase :
88 description : ' GPG passphrase for artifact signing'
99 required : true
10+ update_type :
11+ description : ' One of MAJOR, MINOR, BUILD, PATCH'
12+ required : true
1013
1114runs :
1215 using : " composite"
1316 steps :
14- - name : Get version
15- id : get_version
17+ - name : Get old version
18+ id : get_old_version
19+ shell : bash
20+ run : |
21+ echo "version=$(python build/versionutils.py gradle.properties)" >> "$GITHUB_OUTPUT"
22+ # Push a version bump back to main. There are failure scenarios that can result
23+ # in published artifacts but an erroneous build, so it's safer to bump the version
24+ # at the beginning
25+ - name : Increment version
26+ shell : bash
27+ run : python build/versionutils.py gradle.properties --increment --commit -u ${{ inputs.update_type }}
28+ - name : Get new version
29+ id : get_new_version
1630 shell : bash
1731 run : |
1832 echo "version=$(python build/versionutils.py gradle.properties)" >> "$GITHUB_OUTPUT"
33+ # We also want to push the tag, because that will be used for the next release's release notes
34+ - name : Create tag
35+ shell : bash
36+ run : git tag -m "Release ${{ steps.get_new_version.outputs.version }}" -f "${{ steps.get_new_version.outputs.version }}"
37+
38+ # We want to do this before anything else, because if the later steps fail, we want to make sure that the full
39+ # change log includes all changes, even if they reference a release that was never actually published.
40+ - name : Update release notes
41+ shell : bash
42+ run : |
43+ python ./build/create_release_notes.py \
44+ --config ./build/release-notes-config.json \
45+ --release-notes-md docs/sphinx/source/ReleaseNotes.md \
46+ --skip-commit $(git log -n 1 --format=%H HEAD) \
47+ --repository ${{ github.repository }} \
48+ --commit \
49+ ${{ steps.get_old_version.outputs.version }} ${{ steps.get_new_version.outputs.version }}
50+ # We move the tag to after the release notes are updated so that later steps (i.e. sphinx) will pick up the udpated
51+ # release notes
52+ - name : Move tag to HEAD
53+ shell : bash
54+ run : git tag -m "Release ${{ steps.get_new_version.outputs.version }}" -f "${{ steps.get_new_version.outputs.version }}"
55+
56+ # push the changes to gradle.properties, the release notes, and the tag as one operation, so if it fails,
57+ # it will be as if the release never did anything
58+ - name : Push Version Update
59+ shell : bash
60+ run : git push origin HEAD "${{ steps.get_new_version.outputs.version }}"
61+
1962 - name : Run Gradle Test
2063 uses : ./actions/gradle-test
2164 with :
@@ -29,36 +72,37 @@ runs:
2972 ORG_GRADLE_PROJECT_signingPassword : ${{ inputs.gpg_passphrase }}
3073
3174 # Post release: Update various files which reference version
32- - name : Update release notes
33- shell : bash
34- run : ARTIFACT_VERSION="${{ steps.get_version.outputs.version }}" ./build/update_release_notes.bash
75+ # Updating the yaml files has to be done after the tests complete, or it will mark tests as failing that aren't
76+ # supported by the previous version.
3577 - name : Update YAML test file versions
3678 uses : ./actions/run-gradle
3779 with :
3880 gradle_command : updateYamsql -PreleaseBuild=true
3981 - name : Commit YAML updates
4082 shell : bash
41- run : python ./build/commit_yamsql_updates.py "${{ steps.get_version .outputs.version }}"
83+ run : python ./build/commit_yamsql_updates.py "${{ steps.get_new_version .outputs.version }}"
4284
43- # Create and push the tag
44- - name : Create tag
45- shell : bash
46- run : git tag -m "Release ${{ steps.get_version.outputs.version }}" -f "${{ steps.get_version.outputs.version }}"
47- - name : Push tag
48- shell : bash
49- run : git push origin "${{ steps.get_version.outputs.version }}"
5085 - name : Push Updates
5186 id : push_updates
5287 shell : bash
5388 run : git push origin
89+ # Continue the build (including downstream steps). If the push fails, we'll create a PR
90+ continue-on-error : true
5491 - name : Create Merge PR if conflict
55- if : failure() && steps.push_updates.conclusion == 'failure'
92+ # Only create the PR if we've otherwise been successful, but the push failed. Note that
93+ # we're checking the .outcome of the push step, which is applied before continue-on-error.
94+ if : success() && steps.push_updates.outcome == 'failure'
5695 uses : peter-evans/create-pull-request@bb88e27d3f9cc69c8bc689eba126096c6fe3dded
5796 id : pr_on_conflict
5897 with :
5998 branch : release-build
6099 branch-suffix : timestamp
61- title : " Updates for ${{ steps.get_version .outputs.version }} release"
100+ title : " Updates for ${{ steps.get_new_version .outputs.version }} release"
62101 sign-commits : true
63102 body : |
64- Updates from release for version ${{ steps.get_version.outputs.version }}. Conflicts during the build prevented automatic updating. Please resolve conflicts by checking out the current branch, merging, and then deleting this branch.
103+ Updates from release for version ${{ steps.get_new_version.outputs.version }}. Conflicts during the build prevented automatic updating. Please resolve conflicts by checking out the current branch, merging, and then deleting this branch.
104+
105+ # Creating the PR can change the current branch. Explicitly check out the tag here for downstream builds
106+ - name : Revert to tag
107+ shell : bash
108+ run : git checkout "${{ steps.get_new_version.outputs.version }}"
0 commit comments