From 786f5e83e54e449b8bed5af23e14113f225d9301 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Sun, 26 Mar 2023 00:16:39 +0100 Subject: [PATCH] add documentation --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e01265c --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# setup-forgejo + + +## Description + +Setup Forgejo and a runner + + + +## Inputs + +| parameter | description | required | default | +| --- | --- | --- | --- | +| image | Container image | `false` | codeberg.org/forgejo/forgejo | +| image-version | Container image version | `false` | 1.19 | +| user | Administrator user name | `false` | root | +| password | Administrator password | `false` | admin1234 | +| runner | Runner git repository | `false` | https://code.forgejo.org/fogejo/runner | +| runner-version | Runner version | `false` | v1.4.1 | + + + + +## Outputs + +| parameter | description | +| --- | --- | +| url | URL | +| token | Application token | + + +## Example + +``` +name: Setup Forgejo +on: [push] +jobs: + setup-forgejo: + runs-on: self-hosted + steps: + - uses: actions/checkout@v3 + - id: forgejo + uses: setup-forgejo@v1 + with: + image-version: 1.19 + - run: | + curl ${{ steps.forgejo.outputs.url }}/api/forgejo/v1/version | grep 1.19 + +```