Skip to content

Commit

Permalink
Add changelog template to TagBot config
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikekre committed Nov 28, 2024
1 parent ebc028e commit df566f4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,13 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
ssh: ${{ secrets.DOCUMENTER_KEY }}
changelog: |
{% if custom %}
{{ custom }}
{% endif %}
See [`CHANGELOG.md`](https://github.com/fredrikekre/Runic.jl/blob/master/CHANGELOG.md) for notable changes.
{% if previous_release %}
[Diff since {{ previous_release }}]({{ compare_url }})
{% endif %}

2 comments on commit df566f4

@fredrikekre
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/120319

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.1 -m "<description of version>" df566f48c7834797d1b6eb884d6372fcb6575449
git push origin v1.0.1

Please sign in to comment.