Skip to content

Update CommentBot.jl release note recommendation #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 18, 2024
Merged

Update CommentBot.jl release note recommendation #439

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22ffd2c
Update CommentBot.jl release note recommendation
ericphanson Dec 17, 2024
01e2e44
Update src/commentbot/CommentBot.jl
ericphanson Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/commentbot/CommentBot.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,12 @@ function make_pull_request(pp::ProcessedParams, rp::RequestParams, rbrn::RegBran
releasenotes_note = if isempty(rp.release_notes)
"""

### Tip: Release Notes
### Recommendation: add release notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
Release notes help your users know what has changed in the new version. For breaking releases in particular,
its recommended to document what breaking changes have made (or point to where changes can be found, such as a changelog).

To add release notes, 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.

Expand All @@ -117,7 +120,7 @@ function make_pull_request(pp::ProcessedParams, rp::RequestParams, rbrn::RegBran
- blah
```

To add them here just re-invoke and the PR will be updated.
To add release notes to this registration, just re-invoke JuliaRegistrator and the PR will be updated.

"""
else
Expand Down
Loading