]> git.ardis.lu - csvio/commitdiff
Simplify release notes to be auto generated
authorArdis Lu <ardisglu@gmail.com>
Wed, 4 Jun 2025 06:45:32 +0000 (23:45 -0700)
committerArdis Lu <ardisglu@gmail.com>
Wed, 4 Jun 2025 06:45:32 +0000 (23:45 -0700)
Reasons in favor of minimal release notes: (1) Releases is a GitHub functionality, it's better not to invest too much time into vendor-specific configurations. (2) There is no binary associated with this library so Releases has reduced significance. (3) Meaningful release notes are still contained in git tag annotations, which can be carried across hosts.

One downside is losing meaningful messages in email notifications if people subscribe to follow releases on GitHub.

.github/workflows/release.yml

index e36f4e1e8b7f091f75ad592c0b211bc1ed1c84f6..dc9e29c5abe639d6f07153ec4346bebc4a501b81 100644 (file)
@@ -19,17 +19,9 @@ jobs:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
-      - id: "generate-body"
-        run: |
-          {
-            echo 'BODY<<EOF'
-            git tag -l --format='%(contents:subject)%0a%0a%(contents:body)' ${{ github.ref_name }}
-            echo 'EOF'
-          } >> "$GITHUB_OUTPUT"
-      - run: echo ${{ steps.generate-body.outputs.BODY }}
       - uses: softprops/action-gh-release@v2
         with:
-          body: ${{ steps.generate-body.outputs.BODY }}
+          generate_release_notes: true
 
   publish:
     name: Publish to npm
This page took 0.043062 seconds and 4 git commands to generate.