mirror of
https://github.com/apricote/releaser-pleaser.git
synced 2026-01-13 13:21:00 +00:00
72 lines
2.3 KiB
Markdown
72 lines
2.3 KiB
Markdown
# GitHub
|
|
|
|
In this tutorial we show how to install `releaser-pleaser` in your GitHub project.
|
|
|
|
## 1. Repository Settings
|
|
|
|
### 1.1. Squash Merging
|
|
|
|
`releaser-pleaser` requires you to use `squash` merging. With other merge options it can not reliably find the right pull request for every commit on `main`.
|
|
|
|
Open your repository settings to page _General_:
|
|
|
|
> `https://github.com/YOUR-NAME/YOUR-PROJECT/settings`
|
|
|
|
In the "Pull Requests" section make sure that only "Allow squash merging" is enabled and "Allow merge commits" and "Allow rebase merging" is disabled.
|
|
|
|
|
|
|
|
### 1.2. Workflow Permissions
|
|
|
|
`releaser-pleaser` creates [release pull requests](../explanation/release-pr.md) for you. By default, Actions are not allowed to create pull requests, so we need to enable this.
|
|
|
|
Open your repository settings to page _Actions > General_:
|
|
|
|
> `https://github.com/YOUR-NAME/YOUR-PROJECT/settings/actions`
|
|
|
|
In the "Workflow permissions" section make sure that "Allow GitHub Actions to create and approve pull requests" is enabled.
|
|
|
|
|
|
|
|
## 2. GitHub Actions Workflow
|
|
|
|
Create a new file `.github/workflows/releaser-pleaser.yaml` with this content. Make sure that it is available on the `main` branch.
|
|
|
|
```yaml
|
|
name: releaser-pleaser
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request_target:
|
|
types:
|
|
- edited
|
|
- labeled
|
|
- unlabeled
|
|
|
|
jobs:
|
|
releaser-pleaser:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
steps:
|
|
- name: releaser-pleaser
|
|
uses: apricote/releaser-pleaser@v0.2.0
|
|
```
|
|
|
|
## 3. Release Pull Request
|
|
|
|
Once this job runs for the first time, you can check the logs to see what it did.
|
|
If you have releasable commits since the last tag, `releaser-pleaser` opens a release pull request for the proposed release.
|
|
|
|
Once you merge this pull request, `releaser-pleaser` automatically creates a Git tag and GitHub Release with the proposed version and changelog.
|
|
|
|
## Related Documentation
|
|
|
|
- **Explanation**
|
|
- [Release Pull Request](../explanation/release-pr.md)
|
|
- **Guide**
|
|
- [GitHub Workflow Permissions](../guides/github-workflow-permissions.md)
|
|
- **Reference**
|
|
- [GitHub Action](../reference/github-action.md)
|