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

Document that bpo issues can be automatically closed using commit message #502

Closed
Mariatta opened this issue Jun 27, 2019 · 6 comments
Closed
Assignees
Labels

Comments

@Mariatta
Copy link
Member

According to PEP 595, bpo now has a feature where issues can be automatically closed, if the PR commit message looks like closes bpo-NNNN: ...

This should be documented in devguide and announced to core devs/core-workflow mailing list/discourse.

Some questions: what magic keywords accepted? "closes" "fixes" "close" "fix"?
Is it case sensitive? (I assume not)

Does it also update the "resolution" / "stage"?

@webknjaz
Copy link

Better follow what GitHub has: https://help.github.com/en/articles/closing-issues-using-keywords
This way people won't have to relearn which words work on which platform

Mariatta referenced this issue in python/peps Jul 9, 2019
- include recent changes to bpo
- clarify the downsides of GitHub
@Mariatta
Copy link
Member Author

Reading bpo's source code, the magic words are matching this regex

VERBS = r'(?:\b(?P<verb>close[sd]?|closing|fix(?:e[sd])?|)\s+)?'

@kumiDa
Copy link
Contributor

kumiDa commented May 17, 2021

@Mariatta, as per the below regex I understand that the matched words are -
close, closes,closed closing, fix, fixes, fixed

VERBS = r'(?:\b(?Pclose[sd]?|closing|fix(?:e[sd])?|)\s+)?'

One thing I wanted to point out from https://help.github.com/en/articles/closing-issues-using-keywords
is that it would be nice to incorporate resolve, resolves, resolved into this regex. I would be more than happy to integrate this change into psf/bpo-roundup, let me know your thoughts and if there are any additional processes involved in proposing this change apart from raising an issue and a PR.

@Mariatta
Copy link
Member Author

@rahul-kumi I think it's a great suggestion. I'm not actually involved in bpo development, so perhaps the bpo maintainers can give you better guidance on how to contribute there.

From my perspective though, considering that we'll be migrating away to GitHub Issues, I think at this point it's not worth making such change to b.p.o. I do think it would still be great to document the existing behavior.

kumiDa added a commit to kumiDa/devguide that referenced this issue May 18, 2021
Feature that was included in PEP-595 to automatically close issue
in the bug tracker when a PR with commit message including words like-
close, closes, closed, closing, fix, fixes or fixed being used with
issue number is merged is documented in the devguide.
@kumiDa
Copy link
Contributor

kumiDa commented May 18, 2021

Thanks for the clarification @Mariatta.
I have raised PR #701 documenting the feature.
Let me know if any improvement is to be made to the PR.

@ezio-melotti ezio-melotti self-assigned this May 5, 2022
@ezio-melotti
Copy link
Member

Since we migrated to GitHub, this can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants