-
Notifications
You must be signed in to change notification settings - Fork 47
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.
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
Add release notes note if no release notes provided #360
Add release notes note if no release notes provided #360
Conversation
src/commentbot/CommentBot.jl
Outdated
|
||
### Tip: Release Notes | ||
|
||
Did you know you can add release notes too? Just add markdown formatted text underneath the comment and it will be added to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this isn't enough; you need to format it to pass this regex:
notes_match = match(r"(?:patch|release) notes:(.*)"si, get_body(evt.payload)) |
like described here: https://github.com/JuliaRegistries/Registrator.jl#release-notes.
But maybe we could relax that regex, or just mention they should write "Release notes:"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah ok. I updated it. If JuliaRegistrator writes @JuliaRe...
as an example, will that cause the universe to collapse?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you put the ping inside of backticks, JuliaRegistrator shouldn't actually get pinged, so you should be good there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But if the ping isn't in backticks, I actually do think that the bot will get caught in a loop replying to itself 😂
And eventually hit its rate limit, causing all registrations to grind to a halt.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
uhhh maybe 🤔. I think in
Registrator.jl/src/commentbot/CommentBot.jl
Line 188 in 1558fb7
function comment_handler(event::WebhookEvent, phrase::RegexMatch) |
user = get_user_login(evt.payload) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I was just thinking that. I'll try to make a PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
29ae4dd
to
5475c3c
Compare
5475c3c
to
769e338
Compare
Now that TagBot is fixed can we add this? |
Untested, but should look something like this:
Registration pull request created: JuliaRegistries/General/xxxx
Tip: Release Notes
Did you know you can add release notes too? Just add markdown formatted text underneath the comment and it will be added to the registry PR, and if tagbot is installed it will also be added to the tag created on this repository.
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: