From 6787cd1bd1a2b1bdc254945e9503fd494e788abe Mon Sep 17 00:00:00 2001
From: Earl Warren <contact@earl-warren.org>
Date: Thu, 30 Mar 2023 14:18:23 +0200
Subject: [PATCH] add README

---
 README.md  | 40 ++++++++++++++++++++++++++++++++++++++++
 action.yml |  4 +++-
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..23a98cd
--- /dev/null
+++ b/README.md
@@ -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"
+```
diff --git a/action.yml b/action.yml
index e13642e..d6f0127 100644
--- a/action.yml
+++ b/action.yml
@@ -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