scripts, .github/workflows: add script to extract changelog

the release workflow will use the script to extract the changelog and uses it to create a release note. It also uses tag name to determine if the release is pre-release or not. Signed-off-by: jiaxiao zhou <[email protected]>
containerd · Oct 4, 2024 · b2d41ad · b2d41ad
1 parent c41268a
commit b2d41ad
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -143,10 +143,27 @@ jobs:
  run: |
  git tag "${{matrix.crate}}/v${{matrix.version}}"
  git push origin "${{matrix.crate}}/v${{matrix.version}}"
+ - name: Extract release notes
+ if: ${{ matrix.crate == 'containerd-shim-wasm' && !inputs.dry_run }}
+ run: 
+ cd $GITHUB_WORKSPACE
+ ./scripts/extract-changelog.sh ${{matrix.version}} > RELEASE_NOTES.md
+ cat RELEASE_NOTES.md
  - name: Create release
  if: ${{ !inputs.dry_run }}
  run: |
- gh release create 'refs/tags/${{matrix.crate}}/v${{matrix.version}}' --generate-notes
+ TAG_NAME=${{matrix.version}}
+ if [[ "$TAG_NAME" =~ .+-pre.* ]]; then
+ PRERELEASE_ARGS="--prerelease --latest=false"
+ else
+ PRERELEASE_ARGS=""
+ fi 
+ 
+ gh release create 'refs/tags/${{matrix.crate}}/v${{matrix.version}}' \
+ --title "${{matrix.crate}}/v${{matrix.version}}" \
+ --notes-file RELEASE_NOTES.md \
+ --verify-tag \
+ $PRERELEASE_ARGS \
  env:
  GH_TOKEN: ${{ github.token }}
  RELEASE_NAME: ${{ matrix.crate }}/v${{ matrix.version }}

diff --git a/scripts/extract-changelog.sh b/scripts/extract-changelog.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+# Inspired by https://stackoverflow.com/questions/40450238/parse-a-changelog-and-extract-changes-for-a-version
+# This script will extract the changelog for a specific version from the CHANGELOG.md file
+# Usage: ./extract-changelog.sh <version>
+version=$1
+
+awk -v ver="$version" '
+/^## \[.*\]/ {
+ if (p) exit
+ if ($0 ~ "^## \\[" ver "\\]") { p=1; next }
+}
+p' crates/containerd-shim-wasm/CHANGELOG.md