add README

This commit is contained in:
Earl Warren 2023-03-30 14:18:23 +02:00
parent 3a07a6062f
commit 6787cd1bd1
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
2 changed files with 43 additions and 1 deletions

40
README.md Normal file
View file

@ -0,0 +1,40 @@
# forgejo-release
<!-- action-docs-description -->
## Description
Upload or download the assets of a release to a Forgejo instance.
<!-- action-docs-description -->
<!-- action-docs-inputs -->
## Inputs
| parameter | description | required | default |
| --- | --- | --- | --- |
| url | URL of the Forgejo instance | `false` | |
| repo | owner/project relative to the URL | `false` | |
| tag | Tag of the release | `false` | |
| sha | SHA of the release | `false` | |
| doer | Forgejo user authoring the upload | `false` | |
| token | Forgejo application token | `true` | |
| release-dir | Directory in whichs release assets are uploaded or downloaded | `true` | |
| release-notes | Release notes | `false` | |
| direction | Can either be download or upload | `true` | |
| verbose | Increase the verbosity level | `false` | false |
<!-- action-docs-inputs -->
## Example
```
on: [tag]
jobs:
upload-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/forgejo-release@v1
with:
direction: upload
url: https://code.forgejo.org
release-dir: dist/release
release-notes: "MY RELEASE NOTES"
```

View file

@ -9,7 +9,6 @@ inputs:
description: 'owner/project relative to the URL'
tag:
description: 'Tag of the release'
required: true
sha:
description: 'SHA of the release'
doer:
@ -44,6 +43,9 @@ runs:
export REPO="${{ github.repository }}"
fi
export TAG="${{ inputs.tag }}"
if test -z "$TAG"; then
export TAG="${{ github.ref_name }}"
fi
export DOER="${{ inputs.doer }}"
export TOKEN="${{ inputs.token }}"
if test -z "$TOKEN"; then