Update https://code.forgejo.org/actions/setup-forgejo action to v3.1.4 (#139)

Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/139
Co-authored-by: Renovate Bot <bot@kriese.eu>
Co-committed-by: Renovate Bot <bot@kriese.eu>

.forgejo/workflows/integration.yml

@@ -1,9 +1,11 @@
-on: [ pull_request, push ]
+on:
-
+  pull_request:
+  push:
+    branches:
+      - "**"
 
 env:
-  FORGEJO_VERSION: 11.0.9 # renovate: datasource=docker depName=code.forgejo.org/forgejo/forgejo
+  FORGEJO_VERSION: 11.0.10 # renovate: datasource=docker depName=data.forgejo.org/forgejo/forgejo
-
 
 jobs:
   integration:
@@ -12,7 +14,7 @@ jobs:
       - uses: actions/checkout@v6
 
       - id: forgejo
-        uses: https://code.forgejo.org/actions/setup-forgejo@v3.1.0
+        uses: https://code.forgejo.org/actions/setup-forgejo@v3.1.4
         with:
           user: testuser
           password: admin1234
@@ -46,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
@@ -68,7 +101,7 @@ jobs:
           testdata/forgejo-release-test.sh test_run testuser otherrepo
 
       - if: always()
-        name: '[RUNNER] and [FORGEJO] logs'
+        name: "[RUNNER] and [FORGEJO] logs"
         run: |
           runner_logs="${{ steps.forgejo.outputs.runner-logs }}"
           if test -f "$runner_logs"; then

.forgejo/workflows/release.yml

@@ -0,0 +1,23 @@
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  publish:
+    runs-on: docker
+
+    steps:
+      # needs to be in a different dir, so binary and rna cache don't conflict
+      - uses: https://data.forgejo.org/actions/checkout@v6
+        with:
+          path: forgejo-release
+
+      - name: publish release
+        uses: ./forgejo-release
+        with:
+          direction: upload
+          override: ${{ vars.OVERRIDE || 'false' }}
+          verbose: ${{ vars.VERBOSE || 'false' }}
+          release-notes-assistant: true
+          skip-assets: true

.forgejo/workflows/tests.yml

@@ -1,10 +1,27 @@
-on: [ pull_request, push ]
+on:
+  pull_request:
+  push:
+    branches:
+      - "**"
+
 jobs:
   tests:
     runs-on: docker
+    container:
+      image: data.forgejo.org/oci/node:24-trixie
+
     steps:
       - uses: actions/checkout@v6
 
+      - name: lint action-docs
+        run: |
+          npx --yes action-docs -u
+          git diff --quiet || {
+            echo "[ERROR] Please apply the changes action-docs suggests:"
+            git diff --color=always
+            exit 1
+          }
+
       - name: Unit tests of the supporting script forgejo-release.sh
         run: |
           testdata/forgejo-release-test.sh test_system_tea_bin

README.md

@@ -10,14 +10,15 @@ Upload or download the assets of a release to a Forgejo instance.
 
 | name | description | required | default |
 | --- | --- | --- | --- |
-| `url` | <p>URL of the Forgejo instance</p> | `false` | `${{ env.GITHUB_SERVER_URL }}` |
+| `url` | <p>URL of the Forgejo instance</p> | `false` | `${{ env.FORGEJO_SERVER_URL }}` |
-| `repo` | <p>owner/project relative to the URL</p> | `false` | `${{ github.repository }}` |
+| `repo` | <p>owner/project relative to the URL</p> | `false` | `${{ forge.repository }}` |
-| `tag` | <p>Tag of the release</p> | `false` | `${{ github.ref_name }}` |
+| `tag` | <p>Tag of the release</p> | `false` | `${{ forge.ref_name }}` |
 | `title` | <p>Title of the release (defaults to tag)</p> | `false` | `""` |
-| `sha` | <p>SHA of the release</p> | `false` | `${{ github.sha }}` |
+| `sha` | <p>SHA of the release</p> | `false` | `${{ forge.sha }}` |
-| `token` | <p>Forgejo application token (must have `write:repository`)</p> | `false` | `${{ secrets.GITHUB_TOKEN }}` |
+| `token` | <p>Forgejo application token (must have <code>write:repository</code>)</p> | `false` | `${{ forge.token }}` |
-| `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` |
+| `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` | `""` |
@@ -28,6 +29,7 @@ Upload or download the assets of a release to a Forgejo instance.
 | `prerelease` | <p>Mark Release as Pre-Release</p> | `false` | `false` |
 | `release-notes-assistant` | <p>Generate release notes with Release Notes Assistant</p> | `false` | `false` |
 | `hide-archive-link` | <p>Hide the archive links</p> | `false` | `false` |
+| `skip-assets` | <p>Skip uploading release assets</p> | `false` | `false` |
 <!-- action-docs-inputs source="action.yml" -->
 
 ## Examples
@@ -42,7 +44,7 @@ jobs:
     runs-on: docker
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/forgejo-release@v2.7.3
+      - uses: actions/forgejo-release@v2.9.1
         with:
           direction: upload
           url: https://my-forgejo-instance.net
@@ -53,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:
@@ -63,7 +86,7 @@ jobs:
     runs-on: docker
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/forgejo-release@v2.7.3
+      - uses: actions/forgejo-release@v2.9.1
         with:
           direction: download
           url: https://my-forgejo-instance.net
@@ -83,5 +106,5 @@ Using [action-docs](https://github.com/npalm/action-docs):
 
 ```shell
 # Edit the action.yml file and run:
-action-docs --update-readme
+npx action-docs --update-readme
 ```

action.yml

@@ -19,13 +19,15 @@ inputs:
     description: 'SHA of the release'
     default: '${{ forge.sha }}'
   token:
-    description: 'Forgejo application token'
+    description: 'Forgejo application token (must have `write:repository`)'
     default: '${{ forge.token }}'
   release-dir:
-    description: 'Directory in whichs release assets are uploaded or downloaded'
+    description: 'Directory in which release assets are uploaded or downloaded'
-    required: true
+    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
@@ -37,22 +39,25 @@ inputs:
     description: 'Number of times to retry if the release is not ready (default 1)'
   download-latest:
     description: 'Download the latest release'
-    default: false
+    default: 'false'
   verbose:
     description: 'Increase the verbosity level'
-    default: false
+    default: 'false'
   override:
     description: 'Override an existing release by the same `{tag}`'
-    default: false
+    default: 'false'
   prerelease:
     description: 'Mark Release as Pre-Release'
-    default: false
+    default: 'false'
   release-notes-assistant:
     description: 'Generate release notes with Release Notes Assistant'
-    default: false
+    default: 'false'
   hide-archive-link:
     description: 'Hide the archive links'
-    default: false
+    default: 'false'
+  skip-assets:
+    description: Skip uploading release assets
+    default: 'false'
 
 runs:
   using: "composite"
@@ -97,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 }}"
@@ -113,5 +128,7 @@ runs:
         echo -n "${{ inputs.gpg-passphrase }}" > $TMP_DIR/gpg-passphrase
         export GPG_PASSPHRASE="$TMP_DIR/gpg-passphrase"
 
+        export SKIP_ASSETS="${{ inputs.skip-assets }}"
+
         forgejo-release.sh ${{ inputs.direction }}
       shell: bash

forgejo-release.sh

@@ -18,8 +18,9 @@ if ${VERBOSE:-false}; then set -x; fi
 : ${HIDE_ARCHIVE_LINK:=false}
 : ${RETRY:=1}
 : ${DELAY:=10}
+: ${SKIP_ASSETS:=false}
 
-RELEASE_NOTES_ASSISTANT_VERSION=v1.5.1 # renovate: datasource=forgejo-releases depName=forgejo/release-notes-assistant registryUrl=https://code.forgejo.org
+RELEASE_NOTES_ASSISTANT_VERSION=v1.5.2 # renovate: datasource=forgejo-releases depName=forgejo/release-notes-assistant registryUrl=https://code.forgejo.org
 
 TAG_FILE="$TMP_DIR/tag$$.json"
 TAG_URL=$(echo "$TAG" | sed 's/\//%2F/g')
@@ -84,9 +85,11 @@ upload_release() {
     # It is expanded using "${assets[@]}" which preserves the separation of arguments and not split whitespace containing values.
     # For reference, see https://github.com/koalaman/shellcheck/wiki/SC2086#exceptions
     local assets=()
-    for file in "$RELEASE_DIR"/*; do
+    if [ "$SKIP_ASSETS" == 'false' ]; then
-        assets=("${assets[@]}" -a "$file")
+        for file in "$RELEASE_DIR"/*; do
-    done
+            assets=("${assets[@]}" -a "$file")
+        done
+    fi
     if $PRERELEASE || echo "${TAG}" | grep -qi '\-rc'; then
         releaseType="--prerelease"
         echo "Uploading as Pre-Release"
@@ -207,7 +210,7 @@ download() {
     (
         mkdir -p $RELEASE_DIR
         cd $RELEASE_DIR
-        if [[ ${DOWNLOAD_LATEST} == "true" ]]; then
+        if [[ ${DOWNLOAD_LATEST} = "true" ]]; then
             echo "Downloading the latest release"
             api GET repos/$REPO/releases/latest >"$TMP_DIR"/assets.json
         elif [[ ${DOWNLOAD_LATEST} == "false" ]]; then

testdata/nested-upload-download/.forgejo/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v6
       - id: forgejo
-        uses: https://code.forgejo.org/actions/setup-forgejo@v3.1.0
+        uses: https://code.forgejo.org/actions/setup-forgejo@v3.1.4
         with:
           user: testuser
           password: admin1234

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

testdata/upload-download/.forgejo/workflows/test.yml

@@ -92,5 +92,35 @@ jobs:
       - if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
         run: |
           diff -u upload-dir-v3 download-dir-v3
+
+      - if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        id: release-upload-v4
+        uses: SELF@vTest
+        with:
+          direction: upload
+          tag: v4.0
+          token: FORGEJO_TEST_TOKEN
+          skip-assets: true
+          verbose: true
+
+      - if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        id: release-download-v4
+        uses: SELF@vTest
+        with:
+          direction: download
+          tag: v4.0
+          token: FORGEJO_TEST_TOKEN
+          release-dir: download-dir-v4
+      - if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        run: |
+          if [ ! -d download-dir-v4 ]; then
+            echo "Missing download dir"
+            exit 1
+          fi
+          if [ ! -z "$( ls -A download-dir-v4 )" ]; then
+            echo "Unexpected download files: $( ls -A download-dir-v4 )"
+            exit 1
+          fi
+
       - if: failure()
         run: docker logs forgejo