#1 : Publish generic package to gitea

+ documentation updated

.gitea/workflows/test.yaml

@@ -12,19 +12,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - run: touch text.txt
-      - uses: https://source.vague.tech/open-vague/ci-actions/publish@feature/1-publish
-        with:
-          file: text.txt
-          package: a-proper-test-package
-          version: master
       - uses: https://source.vague.tech/open-vague/ci-actions/publish@feature/1-publish
         with:
           file: text.txt
           package: a-proper-test-package
           version: master
           force: true
-      - uses: https://source.vague.tech/open-vague/ci-actions/publish@feature/1-publish
-        with:
-          file: text.txt
-          package: a-proper-test-package
-          version: master

README.md

@@ -6,4 +6,22 @@ For these actions to work properly one needs a bot account for the token. So, on
 
 The recommended way is to create a team in the organization that has access to all repositories and set `Releases:Write` and `Packages:Write` permissions and `Read` for all the rest (yet, strictly speaking that's not necessary) and add the bot to the team.
 
-Add an organization level secret called `ACTI_BOT_TOKEN` with the bot's token as value.
+The workflow (or jobs individually) needs to define an env variable `ACTI_BOT_TOKEN` with the bots token (as secrets do not automatically propagate into composite action context, at least it didn't work while testing).
+
+## Publish
+
+Publishes a `generic` package to current Gitea instance. Example:
+
+```yaml
+  - uses: https://source.vague.tech/open-vague/ci-actions/publish@feature/1-publish
+    with:
+      file: some-content.json
+      package: the-package
+      version: master
+      force: true
+```
+
+* `file` - path to the file to upload (used as uploaded file name within the package)
+* `package` - the package name
+* `version` - the package version, need to be unique (unless force flag is set)
+* `force` - false by default; if set **deletes the whole version** of the package (all files) and then publishes instead with the same version