feat: release notes from file (#141)

Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/141
Reviewed-by: Michael Kriese <michael.kriese@gmx.de>
Co-authored-by: nihklas <nihklas@noreply.code.forgejo.org>
Co-committed-by: nihklas <nihklas@noreply.code.forgejo.org>

.forgejo/workflows/integration.yml

@@ -48,6 +48,37 @@ jobs:
 
           test $(cat /tmp/v1.json | jq -r .hide_archive_links) = true
 
+      - name: testdata/release-notes-file
+        run: |
+          export LOOP_DELAY=30
+          export FORGEJO_RUNNER_LOGS="${{ steps.forgejo.outputs.runner-logs }}"
+          forgejo-test-helper.sh run_workflow testdata/release-notes-file http://testuser:admin1234@${{ steps.forgejo.outputs.host-port }} testuser release-notes-file forgejo-release "${{ steps.forgejo.outputs.token }}"
+
+          set -ex
+          export FORGEJO="${{ steps.forgejo.outputs.url }}"
+          curl --fail -sS $FORGEJO/api/v1/repos/testuser/release-notes-file/releases/tags/v1.0 > /tmp/v1.json
+          curl --fail -sS $FORGEJO/api/v1/repos/testuser/release-notes-file/releases/tags/v2.0 > /tmp/v2.json
+          curl --fail -sS $FORGEJO/api/v1/repos/testuser/release-notes-file/releases/tags/v3.0 > /tmp/v3.json
+
+          EXPECTED='# This is a Release Note
+
+          Some *formatted*,
+
+          multiline
+
+          Markdown content.
+
+          ```bash
+          echo "Even a code block"
+          ```'
+          test "$EXPECTED" = "$(jq -r .body < /tmp/v1.json)"
+
+          test "$EXPECTED" = "$(jq -r .body < /tmp/v2.json)"
+          test "I wont be there" != "$(jq -r .body < /tmp/v2.json)"
+
+          test "$EXPECTED" != "$(jq -r .body < /tmp/v3.json)"
+          test "I will be there" = "$(jq -r .body < /tmp/v3.json)"
+
       - name: testdata/upload-download-private
         run: |
           export LOOP_DELAY=30

README.md

@@ -18,6 +18,7 @@ Upload or download the assets of a release to a Forgejo instance.
 | `token` | <p>Forgejo application token (must have <code>write:repository</code>)</p> | `false` | `${{ forge.token }}` |
 | `release-dir` | <p>Directory in which release assets are uploaded or downloaded</p> | `false` | `dist/release` |
 | `release-notes` | <p>Release notes</p> | `false` | `""` |
+| `release-notes-file` | <p>Path to a file containing your release notes (takes priority over <code>release-notes</code>)</p> | `false` | `""` |
 | `direction` | <p>Can either be <code>download</code> or <code>upload</code></p> | `true` | `""` |
 | `gpg-private-key` | <p>GPG Private Key to sign the release artifacts</p> | `false` | `""` |
 | `gpg-passphrase` | <p>Passphrase of the GPG Private Key</p> | `false` | `""` |
@@ -54,6 +55,27 @@ jobs:
           release-notes: "MY RELEASE NOTES"
 ```
 
+Upload a release with custom release notes located in a file:
+
+```yaml
+jobs:
+  upload-release:
+    runs-on: docker
+    steps:
+      - uses: actions/checkout@v4
+      - name: Generate Changelog
+        run: ./generate-changelog.sh > dist/changelog.md
+      - uses: actions/forgejo-release@v2.7.3
+        with:
+          direction: upload
+          url: https://my-forgejo-instance.net
+          repo: myuser/myrepo
+          token: ${{ secrets.WRITE_TOKEN_TO_MYREPO }}
+          tag: v13.0.2
+          release-dir: dist/release
+          release-notes-file: dist/changelog.md
+```
+
 ### Download
 
 Example downloading the forgejo release v1.21.4-0 into the working directory:

action.yml

@@ -26,6 +26,8 @@ inputs:
     default: 'dist/release'
   release-notes:
     description: 'Release notes'
+  release-notes-file:
+    description: 'Path to a file containing your release notes (takes priority over `release-notes`)'
   direction:
     description: 'Can either be `download` or `upload`'
     required: true
@@ -100,6 +102,16 @@ runs:
         EOF
         )
 
+        RELEASENOTES_FILE="${{ inputs.release-notes-file }}"
+        if [ ! -z "$RELEASENOTES_FILE" ]; then
+          if [ ! -f "$RELEASENOTES_FILE" ]; then
+            echo "! Release notes file $RELEASENOTES_FILE does not exist."
+            exit 1
+          fi
+
+          export RELEASENOTES=$(cat "$RELEASENOTES_FILE")
+        fi
+
         export SHA="${{ inputs.sha }}"
 
         export OVERRIDE="${{ inputs.override }}"

testdata/release-notes-file/.forgejo/workflows/test.yml

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: MIT
+
+name: Upload a release with Release Notes to the project that runs the workflow
+on: [push]
+jobs:
+  upload-download:
+    runs-on: lxc-bookworm
+    steps:
+      - uses: actions/checkout@v6
+      - if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        id: release-notes-file
+        uses: SELF@vTest
+        with:
+          direction: upload
+          tag: v1.0
+          token: FORGEJO_TEST_TOKEN
+          release-dir: upload-dir
+          release-notes-file: upload-dir/RELEASE_NOTES.md
+          verbose: true
+
+      - uses: actions/checkout@v6
+      - if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        id: release-notes-file-takes-precedence
+        uses: SELF@vTest
+        with:
+          direction: upload
+          tag: v2.0
+          token: FORGEJO_TEST_TOKEN
+          release-dir: upload-dir
+          release-notes: "I wont be there"
+          release-notes-file: upload-dir/RELEASE_NOTES.md
+          verbose: true
+
+      - uses: actions/checkout@v6
+      - if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        id: release-notes
+        uses: SELF@vTest
+        with:
+          direction: upload
+          tag: v3.0
+          token: FORGEJO_TEST_TOKEN
+          release-dir: upload-dir
+          release-notes: "I will be there"
+          verbose: true

testdata/release-notes-file/.gitignore

@@ -0,0 +1 @@
+*~

testdata/release-notes-file/upload-dir/RELEASE_NOTES.md

@@ -0,0 +1,12 @@
+# This is a Release Note
+
+Some *formatted*,
+
+multiline
+
+Markdown content.
+
+```bash
+echo "Even a code block"
+```
+

testdata/release-notes-file/upload-dir/file 3.txt

@@ -0,0 +1 @@
+FILE3

testdata/release-notes-file/upload-dir/file1.txt

@@ -0,0 +1 @@
+FILE1

testdata/release-notes-file/upload-dir/file2.txt

@@ -0,0 +1 @@
+FILE2