docs: update readme #56
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# https://johanneskonings.dev/github/2021/02/28/github_automatic_releases_and-changelog/ | |
# https://tiagomichaelsousa.dev/articles/stop-writing-your-changelogs-manually | |
name: Release Drafter | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
update_release_draft: | |
name: Release drafter | |
runs-on: ubuntu-latest | |
permissions: | |
# write permission is required to create a github release | |
contents: write | |
# write permission is required for autolabeler | |
# otherwise, read permission is required at least | |
pull-requests: write | |
steps: | |
- name: Update Release Draft | |
uses: release-drafter/release-drafter@v5 | |
id: semantic | |
with: | |
config-name: release-drafter.yml | |
## Default versioning just increase the path version as default. but the can use minor, patch and breaking-changes labels to apply semver | |
# version: 1.29.1 | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
# - name: Do something when a new release published | |
# run: | | |
# echo ${{ $RESOLVED_VERSION steps.semantic.outputs }} |