From 05d41bd91513e4e02b6f6b7167706c31373ffbd6 Mon Sep 17 00:00:00 2001
From: crueter <crueter@eden-emu.dev>
Date: Tue, 11 Nov 2025 21:27:19 -0500
Subject: [PATCH] feat: release notes from file

Takes priority over `release-notes`. Most useful in cases where we need
to generate something from a script; for example, if you have like 80
different assets and autogenerate a table to make it easier for users to
select their platform/sums/etc

Signed-off-by: crueter <crueter@eden-emu.dev>
---
 README.md  | 22 ++++++++++++++++++++++
 action.yml | 13 +++++++++++++
 2 files changed, 35 insertions(+)

diff --git a/README.md b/README.md
index 0758032..23bb315 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,7 @@ Upload or download the assets of a release to a Forgejo instance.
 | `token` | <p>Forgejo application token</p> | `false` | `${{ secrets.GITHUB_TOKEN }}` |
 | `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` |
 | `release-notes` | <p>Release notes</p> | `false` | `""` |
+| `release-notes-file` | <p>Path to a file containing your release notes (takes priority over `release-notes`)</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` | `""` |
@@ -53,6 +54,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:
diff --git a/action.yml b/action.yml
index f6725c7..3ecf3ed 100644
--- a/action.yml
+++ b/action.yml
@@ -26,6 +26,9 @@ inputs:
     required: true
   release-notes:
     description: 'Release notes'
+  release-notes-file:
+    description: 'Path to a file containing your release notes (takes priority over release-notes)'
+    required: false
   direction:
     description: 'Can either be `download` or `upload`'
     required: true
@@ -97,6 +100,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 }}"