docs: lint and fix (#129)

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

.forgejo/workflows/tests.yml

@@ -2,9 +2,21 @@ on: [ pull_request, push ]
 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,13 +10,13 @@ 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 }}` |
-| `repo` | <p>owner/project relative to the URL</p> | `false` | `${{ github.repository }}` |
-| `tag` | <p>Tag of the release</p> | `false` | `${{ github.ref_name }}` |
+| `url` | <p>URL of the Forgejo instance</p> | `false` | `${{ env.FORGEJO_SERVER_URL }}` |
+| `repo` | <p>owner/project relative to the URL</p> | `false` | `${{ forge.repository }}` |
+| `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 }}` |
-| `token` | <p>Forgejo application token (must have `write:repository`)</p> | `false` | `${{ secrets.GITHUB_TOKEN }}` |
-| `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` |
+| `sha` | <p>SHA of the release</p> | `false` | `${{ forge.sha }}` |
+| `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` | `""` |
 | `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` | `""` |
@@ -28,6 +28,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
@@ -83,5 +84,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,11 +19,11 @@ 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 which release assets are uploaded or downloaded'
-    default: ''
+    default: 'dist/release'
   release-notes:
     description: 'Release notes'
   direction:
@@ -37,22 +37,22 @@ 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'