Skip to content
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

Merged
merged 5 commits into from
Aug 30, 2023

Conversation

IanButterworth
Copy link
Member

Untested, but should look something like this:


@JuliaRegistrator register()

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:

git tag -a v1.3.1 -m "<description of version>" 7d4c8c4c918148afc371e4814d1f2929c3f46b37
git push origin v1.3.1


### 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
Copy link
Member

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:"

Copy link
Member Author

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?

Copy link
Member

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.

Copy link
Member

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.

Copy link
Member

@ericphanson ericphanson Jan 20, 2022

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

function comment_handler(event::WebhookEvent, phrase::RegexMatch)
we could bail if the user is JuliaRegistrator. Or maybe here:
user = get_user_login(evt.payload)
which is called by the constructor in the function above. Not totally sure though

Copy link
Member

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.

Copy link
Member

Choose a reason for hiding this comment

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

@IanButterworth IanButterworth force-pushed the patch-1 branch 2 times, most recently from 29ae4dd to 5475c3c Compare August 27, 2023 19:20
Update CommentBot.jl
@IanButterworth
Copy link
Member Author

@IanButterworth IanButterworth merged commit 53476f1 into JuliaRegistries:master Aug 30, 2023
@IanButterworth IanButterworth deleted the patch-1 branch August 30, 2023 03:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants