Skip to content

Add Bot to CI for What's-new #12814

Closed
Closed

Description

@nstarman

Description

In the Dev Telecon today we discussed #9676. Building on top of that, the suggestion is to add a bot, triggered by the whatsnew-needed tag, to check that there is a what's-new added. Like with the changelog check, the CI should fail if there is not a what's entry.

Require PR authors to write “What’s new” for major features? https://github.com/astropy/astropy/issues/9676
Do we want that? Where do we say so? Suggestion: Add to the PR checklist “[ ] What’s new? entry included in PR (if warranted)”?
The discussion in the issue is stalled, so it seems good to bring it up here to make a decision or suggestion on how to proceed.

Next steps:
- Open Issue for: Bot for checking What’s-new entry exists?

Activity

  1. added a commit that references this issue on Feb 21, 2022
  2. pllim commented on Feb 21, 2022

    @pllim
    Member

    The easiest thing for me to do is to piggyback this check onto the existing changelog entry check bot at actions-towncrier-changelog, which I did. Example of it running:

    No what's new needed

    #12863

    PR labels: ['io.fits', ':zzz: Python3']
    
    No "whatsnew-needed" label, skipping What's New entry check
    No changelog file was added in the correct directories for PR 12863
    

    What's new entry missing

    #12847

    PR labels: ['units', 'whatsnew-needed']
    
    "whatsnew-needed" present but no What's New entry; please add one.
    

    What's new entry added by PR author

    No such example. If you decide to write one for your PR, let me know what the bot says. 😸 🤖

  3. added
    Close?Tell stale bot that this issue/PR is stale
    on Feb 21, 2022
  4. self-assigned this
    on Feb 21, 2022
  5. github-actions commented on Feb 22, 2022

    @github-actions
    Contributor

    Hi humans 👋 - this issue was labeled as Close? approximately 13 hours ago. If you think this issue should not be closed, a maintainer should remove the Close? label - otherwise, I will close this issue in 7 days.

    If you believe I commented on this issue incorrectly, please report this here

  6. pllim commented on Feb 24, 2022

    @pllim
    Member

    @Cadair , @tomdonaldson , and I decided that current implementation is good enough for now. If people are unsatisfied, they can open new issues/PRs. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions