Automatically update README.md from action.yml contents (again) #108

New issue

Open

opened 2025-11-30 19:05:16 +00:00 by stefangehn · 2 comments

stefangehn commented

2025-11-30 19:05:16 +00:00

I just noticed that README.md is outdated for a few of the inputs (and their defaults), however the descriptions in action.yml are up-to-date.

Would it maybe be a good idea to reinstate the automatic updating of README.md from the contents of action.yml using the action-docs action mentioned at the end of the readme file?

Please note that doing this would conflict with actions/forgejo-release!102 and possibly other manual edits done in README.md in the past.

I could create a PR for this if desired or (if not desired) try to make the two files consistent again.

I just noticed that README.md is outdated for a few of the inputs (and their defaults), however the descriptions in action.yml are up-to-date. Would it maybe be a good idea to reinstate the automatic updating of README.md from the contents of action.yml using the `action-docs` action mentioned at the end of the readme file? Please note that doing this would conflict with actions/forgejo-release!102 and possibly other manual edits done in README.md in the past. I could create a PR for this if desired or (if not desired) try to make the two files consistent again.

stefangehn commented

2026-01-11 18:47:46 +00:00

Author

FWIW, the current diff if you run action-docs --update-readme is:

diff --git i/README.md w/README.md
index f00e8bc..b13d8a4 100644
--- i/README.md
+++ w/README.md
@@ -10,12 +10,12 @@ 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 }}` |
+| `sha` | <p>SHA of the release</p> | `false` | `${{ forge.sha }}` |
+| `token` | <p>Forgejo application token</p> | `false` | `${{ forge.token }}` |
 | `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` |
 | `release-notes` | <p>Release notes</p> | `false` | `""` |
 | `direction` | <p>Can either be <code>download</code> or <code>upload</code></p> | `true` | `""` |

FWIW, the current diff if you run `action-docs --update-readme` is: ```patch diff --git i/README.md w/README.md index f00e8bc..b13d8a4 100644 --- i/README.md +++ w/README.md @@ -10,12 +10,12 @@ Upload or download the assets of a release to a Forgejo instance. | name | description | required | default | | --- | --- | --- | --- | -| `url` | URL of the Forgejo instance | `false` | `${{ env.GITHUB_SERVER_URL }}` | -| `repo` | owner/project relative to the URL | `false` | `${{ github.repository }}` | -| `tag` | Tag of the release | `false` | `${{ github.ref_name }}` | +| `url` | URL of the Forgejo instance | `false` | `${{ env.FORGEJO_SERVER_URL }}` | +| `repo` | owner/project relative to the URL | `false` | `${{ forge.repository }}` | +| `tag` | Tag of the release | `false` | `${{ forge.ref_name }}` | | `title` | Title of the release (defaults to tag) | `false` | `""` | -| `sha` | SHA of the release | `false` | `${{ github.sha }}` | -| `token` | Forgejo application token (must have `write:repository`) | `false` | `${{ secrets.GITHUB_TOKEN }}` | +| `sha` | SHA of the release | `false` | `${{ forge.sha }}` | +| `token` | Forgejo application token | `false` | `${{ forge.token }}` | | `release-dir` | Directory in whichs release assets are uploaded or downloaded | `true` | `""` | | `release-notes` | Release notes | `false` | `""` | | `direction` | Can either be <code>download</code> or <code>upload</code> | `true` | `""` | ```