setup-forgejo/README.md

82 lines
2.9 KiB
Markdown
Raw Normal View History

2023-03-25 19:16:39 -04:00
# setup-forgejo
<!-- action-docs-description -->
## Description
Setup Forgejo and a runner.
The forgejo-test-helper.sh script is available to help test and debug actions.
2023-03-29 18:27:54 -04:00
`forgejo=http://root:admin1234@${{ steps.forgejo.outputs.host-port }}`
2023-03-29 18:27:54 -04:00
* `forgejo-test-helper.sh push_self_action $forgejo root myaction vTest`
Creates the repository `$forgejo/root/myaction` and populate it with the
content of the repository under test, except for the `.forgejo` directory
(it would otherwise create an infinite recursion loop). The tag `vTest` is
set to the SHA under test.
* `forgejo-test-helper.sh run_workflow testrepo $forgejo root testrepo myaction`
Create the repository `$forgejo/root/testrepo` and populate it with the
content of the `testrepo` directory. All occurrences of `SELF` in
`testrepo/.forgejo/workflows/*.yml` are replaced with `$forgejo/root/myaction`.
* `forgejo-test-helper.sh push testrepo $forgejo root testrepo`
2023-03-29 18:27:54 -04:00
Create the repository `$forgejo/root/testrepo` and populate it with the
content of the `testrepo` directory. The SHA of the tip of the repository
is in the output, starting with `sha=`.
2023-03-29 18:27:54 -04:00
The combination of `push_self_action` and `run_workflow` allows to
run Forgejo Actions workflows from `testrepo` that use the action
under test (`myaction`) to verify it works as intended.
2023-03-25 19:16:39 -04:00
<!-- action-docs-description -->
2023-03-25 19:34:51 -04:00
It can only be run on the `self-hosted` platform, running on a host with LXC installed.
2023-03-25 19:16:39 -04:00
<!-- 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/forgejo/runner |
2023-05-22 05:27:50 -04:00
| runner-version | Runner version | `false` | v2.0.0 |
| container | Name of the container running the Forgejo instance | `false` | forgejo |
2023-03-29 18:27:54 -04:00
| lxc-ip-prefix | Class C IP prefix used by LXC | `false` | 10.0.23 |
2023-03-25 19:16:39 -04:00
<!-- action-docs-inputs -->
<!-- action-docs-outputs -->
## Outputs
| parameter | description |
| --- | --- |
2023-03-27 11:36:59 -04:00
| url | URL of the Forgejo instance |
| host-port | Host and port of the Forgejo instance, e.g 172.0.17.2:3000 |
| token | Administrator application token with all,sudo scopes |
| runner-logs | Filename of the Forgejo runner logs |
2023-03-25 19:16:39 -04:00
<!-- action-docs-outputs -->
## Example
```
name: Setup Forgejo
on: [push]
jobs:
setup-forgejo:
runs-on: self-hosted
steps:
- uses: actions/checkout@v3
- id: forgejo
2023-03-30 10:11:04 -04:00
uses: actions/setup-forgejo@v1
2023-03-25 19:16:39 -04:00
with:
image-version: 1.19
- run: |
curl ${{ steps.forgejo.outputs.url }}/api/forgejo/v1/version | grep 1.19
```
2023-03-27 10:43:26 -04:00
## Hacking
* Update the README from the action file with https://github.com/npalm/action-docs `action-docs --update-readme`