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

docs: add all current features (#34)

Browse source
This commit is contained in:
Julian Tölle 2024-08-25 22:13:56 +02:00 • committed by GitHub
parent 2567f0ae8b
commit 499f127b9e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 397 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/reference/github-action.md
View file

@ -1 +1,25 @@
# GitHub Action
## Reference
The action is available as `apricote/releaser-pleaser` on GitHub.com.
## Versions
The `apricote/releaser-pleaser` action is released together with `releaser-pleaser` and they share the version number.
The action 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.2.0`.
## Inputs
The following inputs are supported by the `apricote/releaser-pleaser` GitHub Action.
| Input | Description | Default | Example |
| ------------- | :----------------------------------------------------- | --------------: | -------------------------------------------------------------------: |
| `branch` | This branch is used as the target for releases. | `main` | `master` |
| `token` | GitHub token for creating and updating release PRs | `$GITHUB_TOKEN` | `${{secrets.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> |
## Outputs
The action does not define any outputs.