Skip to content

Commit 02e982c

Browse files
authored
ci: Update release workflow to generate release notes (#12132)
GitHub can automatically generate release notes from commit messages. This saves us from having to manually update the `CHANGES.md` file every week. In preparation for the next edge release, this change updates the release workflow to stop relying on the CHANGES file. The CHANGES file is updated with a pointer to the releases page.
1 parent 8bad553 commit 02e982c

File tree

3 files changed

+23
-47
lines changed

3 files changed

+23
-47
lines changed

.github/workflows/release.yml

+13-19
Original file line numberDiff line numberDiff line change
@@ -221,39 +221,33 @@ jobs:
221221
needs:
222222
- tag
223223
- integration_tests
224-
- choco_pack
224+
# TODO(ver) choco packages are not produced for edge releases...
225+
# - choco_pack
225226
if: startsWith(github.ref, 'refs/tags/stable') || startsWith(github.ref, 'refs/tags/edge')
226227
timeout-minutes: 30
227228
runs-on: ubuntu-20.04
228229
permissions:
229230
contents: write
230231
steps:
231232
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
232-
- name: Set environment variables
233-
run: |
234-
echo 'TAG=${{ needs.tag.outputs.tag }}' >> "$GITHUB_ENV"
235-
. bin/_release.sh
236-
extract_release_notes NOTES.md
237-
- name: Download choco package
238-
if: startsWith(github.ref, 'refs/tags/stable')
239-
uses: actions/download-artifact@eaceaf801fd36c7dee90939fad912460b18a1ffe
240-
with:
241-
name: choco
242-
path: choco
233+
# - name: Download choco package
234+
# if: startsWith(github.ref, 'refs/tags/stable')
235+
# uses: actions/download-artifact@eaceaf801fd36c7dee90939fad912460b18a1ffe
236+
# with:
237+
# name: choco
238+
# path: choco
243239
- name: Pull CLI binaries
244-
env:
245-
DOCKER_TARGET: multi-arch
246-
run : |
247-
bin/docker-pull-binaries "$TAG"
248-
v=${TAG#"stable-"}
249-
mv choco/linkerd.*.nupkg "target/release/linkerd2-cli-stable-$v.nupkg" || true
240+
run: DOCKER_TARGET=multi-arch bin/docker-pull-binaries '${{ needs.tag.outputs.tag }}'
241+
# v=${TAG#"stable-"}
242+
# mv choco/linkerd.*.nupkg "target/release/linkerd2-cli-stable-$v.nupkg" || true
250243
- name: Create release
251244
id: create_release
252245
uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
253246
with:
247+
name: '${{ needs.tag.outputs.tag }}'
248+
generate_release_notes: true
254249
draft: false
255250
prerelease: false
256-
body_path: NOTES.md
257251
files: |
258252
./target/release/linkerd2-cli-*-darwin*
259253
./target/release/linkerd2-cli-*-linux-*

CHANGES.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Changes
22

3+
Please visit Linkerd's [Release page][gh-releases] for for the latest release
4+
notes moving forward!
5+
6+
[gh-releases]: https://github.com/linkerd/linkerd2/releases
7+
8+
## edge-24.2.5
9+
10+
* Migrated edge release change notes to use GitHub's automated release notes
11+
feature.
12+
313
## edge-24.2.4
414

515
* Updated the ExternalWorkload CRD to v1beta1, renaming the meshTls field to

bin/_release.sh

-28
This file was deleted.

0 commit comments

Comments
 (0)