Skip to content

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

Closed

Description

@Mariatta

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

Activity

  1. webknjaz commented on Jun 29, 2019

    @webknjaz
    Member

    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

  2. added a commit that references this issue on Jul 9, 2019
  3. Mariatta commented on Jul 11, 2019

    @Mariatta
    MemberAuthor

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

    VERBS = r'(?:\b(?P<verb>close[sd]?|closing|fix(?:e[sd])?|)\s+)?'
    
  4. kumiDa commented on May 17, 2021

    @kumiDa
    Contributor

    @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.

  5. Mariatta commented on May 17, 2021

    @Mariatta
    MemberAuthor

    @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.

  6. added a commit that references this issue on May 18, 2021
    916d00c
  7. kumiDa commented on May 18, 2021

    @kumiDa
    Contributor

    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.

  8. self-assigned this
    on May 5, 2022
  9. ezio-melotti commented on May 5, 2022

    @ezio-melotti
    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

Metadata

Metadata

Assignees

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions