actions/setup-forgejo
actions/setup-forgejo
1
0
Fork 0
mirror of https://code.forgejo.org/actions/setup-forgejo.git synced 2024-12-26 06:42:17 -05:00
Code Issues Projects Releases Packages Wiki Activity

add documentation

Browse source
This commit is contained in:
Earl Warren 2023-03-26 00:16:39 +01:00
parent 9e530416d7
commit 786f5e83e5
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
1 changed files with 49 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.md Normal file
View file

@ -0,0 +1,49 @@
# setup-forgejo
<!-- action-docs-description -->
## Description
Setup Forgejo and a runner
<!-- action-docs-description -->
<!-- action-docs-inputs -->
## 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 |
<!-- action-docs-inputs -->
<!-- action-docs-outputs -->
## Outputs
| parameter | description |
| --- | --- |
| url | URL |
| token | Application token |
<!-- action-docs-outputs -->
## 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
```