apricote/releaser-pleaser
1
0
Fork 0
mirror of https://github.com/apricote/releaser-pleaser.git synced 2026-01-13 13:21:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: GitLab tutorial and CI/CD component reference (#72)

Browse source
This commit is contained in:
Julian Tölle 2024-09-25 11:23:04 +02:00 • committed by GitHub
parent 2621c48d75
commit 1a370c39dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 134 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/reference/gitlab-cicd-component.md Normal file
View file

@ -0,0 +1,23 @@
# GitLab CI/CD Component
## Reference
The CI/CD component is available as `$CI_SERVER_FQDN/apricote/releaser-pleaser/run` on gitlab.com.
It is being distributed through the CI/CD Catalog: [apricote/releaser-pleaser](https://gitlab.com/explore/catalog/apricote/releaser-pleaser).
## Versions
The `apricote/releaser-pleaser` action is released together with `releaser-pleaser` and they share the version number.
The component does not support floating tags (e.g. `v1`) right now ([#31](https://github.com/apricote/releaser-pleaser/issues/31)). You have to use the full version or commit SHA instead: `apricote/releaser-pleaser@v0.4.0`.
## Inputs
The following inputs are supported by the component.
| Input | Description | Default | Example |
| ---------------------- | :-------------------------------------------------------- | ------: | -------------------------------------------------------------------: |
| `branch` | This branch is used as the target for releases. | `main` | `master` |
| `token` (**required**) | GitLab access token for creating and updating release PRs | | `$RELEASER_PLEASER_TOKEN` |
| `extra-files` | List of files that are scanned for version references. | `""` | <pre><code>version/version.go<br>deploy/deployment.yaml</code></pre> |