apricote/releaser-pleaser
1
0
Fork 0
mirror of https://github.com/apricote/releaser-pleaser.git synced 2026-02-07 10:17:02 +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

20
docs/explanation/release-pr.md
View file

@ -1 +1,21 @@
# Release Pull Request
A _release pull request_ is opened by `releaser-pleaser` when it detects that there are _releasable changes_.
The pull request contains an _auto-generated Changelog_ and a _suggested next version_.
Once someone merges this pull request, `releaser-pleaser` will create a matching Git Tag and Release on GitHub/GitLab.
Maintainers can fill various fields in the pull request description and through labels to change the proposed release. Some examples of this are: _Changelog Prefix & Suffix text_ and _requesting a pre-release_ (`alpha`, `beta`, `rc`) version.
The pull request is automatically updated by `releaser-pleaser` every time it runs.
### Example Screenshot
![Screenshot of an example Release Pull Request on GitHub](./release-pr.png)
## Related Documentation
- **Guide**
- [Pre-releases](../guides/pre-releases.md)
- [Release Notes](../guides/release-notes.md)
- **Reference**
- [Pull Request Options](../reference/pr-options.md)