From 583a662ddc06f44dac2b8dc800423a5dab6f8d88 Mon Sep 17 00:00:00 2001 From: Marshall Bowers Date: Wed, 24 Apr 2024 18:56:36 -0400 Subject: [PATCH] Fix issues with drafting release notes in CI (#10955) This PR addresses some issues I ran into with the way we draft release notes in CI when doing builds. The first issue I encountered was that `script/draft-release-notes` was failing, seemingly due to CI doing a shallow Git checkout and not having all of the tags available in order to compare then. This was addressed by setting the `fetch-depth` during the Git checkout. The second issue is that (in my opinion) we shouldn't fail the build if drafting release notes fails. After well, we're doing it as a convenience to ourselves, and it isn't a mandatory part of the build. This was addressed by making any failures in `script/draft-release-notes` not fail the CI step as a whole. These changes were already applied to the `v0.133.x` branch. Release Notes: - N/A --- .github/workflows/ci.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7fa313d5ea..b81becdeff 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -173,6 +173,11 @@ jobs: - name: Checkout repo uses: actions/checkout@v4 with: + # We need to fetch more than one commit so that `script/draft-release-notes` + # is able to diff between the current and previous tag. + # + # 25 was chosen arbitrarily. + fetch-depth: 25 clean: false submodules: "recursive" @@ -206,7 +211,8 @@ jobs: exit 1 fi mkdir -p target/ - script/draft-release-notes "$version" "$channel" > target/release-notes.md + # Ignore any errors that occur while drafting release notes to not fail the build. + script/draft-release-notes "$version" "$channel" > target/release-notes.md || true - name: Generate license file run: script/generate-licenses