From 1fdd8019083005f4d138ac0fba33b8e4715f1cb3 Mon Sep 17 00:00:00 2001 From: Koichi Murase Date: Thu, 16 Jan 2025 21:17:37 +0900 Subject: [PATCH] actions(update-tools): avoid notifying our outdated deps everywhere In the current main branch, workflow update-tools includes the content of the upstream release notes in the created GitHub Issue. This triggers a notification to every upstream contributor mentioned in the release note. This also creates a cross-reference link to our GitHub Issue (reporting that our dependency is not up-to-date) in every upstream issue and pull request. The information that we need to update our dependency is not relavant to the upstream contributors, issues, and pull requests at all. We should avoid this situation. In the first place, we do not need to include a copy of the upstream release note. We can just put a link to the upstream release note. Currently, we anyway hide the content in the
tag and require the reader to press the button. The user experience is not so different from pressing a link and visiting the upstream release note. --- .github/workflows/update-tools.yml | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/.github/workflows/update-tools.yml b/.github/workflows/update-tools.yml index fbfe5a4551e4..676463c55a0f 100644 --- a/.github/workflows/update-tools.yml +++ b/.github/workflows/update-tools.yml @@ -81,13 +81,6 @@ jobs: version_latest=$(curl --silent "https://api.github.com/repos/${{ matrix.tool.PROJECT_NAME }}/releases/latest" | jq -r .tag_name) version_latest=${version_latest#v} # Removing the 'v' prefix since the script uses only plain numbers echo "version_latest=$version_latest" >> $GITHUB_OUTPUT - { - echo "CHANGE_LOG<> "$GITHUB_ENV" - name: Update ${{ matrix.tool.VERSION_VAR}} in script # @TODO Make sure that the version is actually higher, not lower (the 'latest' tag does not neccessarily mean that the version is higher!) @@ -106,13 +99,6 @@ jobs: body: | Bump [${{ matrix.tool.PROJECT_NAME}}](https://github.com/${{ matrix.tool.PROJECT_NAME }}) from ${{ steps.get-version-current.outputs.version_current }} to ${{ steps.get-version-latest.outputs.version_latest }} by bumping `${{ matrix.tool.VERSION_VAR}}` in `${{ matrix.tool.VAR_FILE}}`. -
Release notes -

Sourced from ${{ matrix.tool.PROJECT_NAME }}'s releases. -
Please note that this only shows the release notes for the latest release.

-
- - ${{ env.CHANGE_LOG }} - -
-
+ Check the upstream release notes. +

Please note that the above link only shows the release notes for the latest release.

labels: Dependencies, Bash