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

fix(options)!: Make not_planned the default close-issue-reason #807

Merged
merged 2 commits into from Sep 20, 2022

Conversation

david-allison
Copy link
Contributor

@david-allison david-allison commented Sep 5, 2022

Changes

  • ⚠️ BREAKING CHANGE close-issue-reason defaults to not_planned (previously: ``
    which defaulted to completed) This closes the issue as 'not planned' on GitHub rather than 'completed'
  • documentation: minor improvement to 'DefaultProcessorOptions'
    • I'm happy to drop this if it's an issue - unsure on PR requirements for this repo

Context

GitHub introduced an additional close reason 'Close as not planned':
https://github.blog/changelog/2022-05-19-the-new-github-issues-may-19th-update/

'stale' is a use case for this close reason and makes sense as a default for this action

Fixes #789

Feature added: 06d2a39
Updated: aaab997

GitHub introduced an additional close reason 'Close as not planned':
https://github.blog/changelog/2022-05-19-the-new-github-issues-may-19th-update/

'stale' is a use case for this close reason

Fixes actions#789

BREAKING CHANGE:
`close-issue-reason` defaults to `not_planned` (previously: ``
which defaulted to `completed`)
This closes the issue as 'not planned' on GitHub rather than 'completed'

See: https://github.blog/changelog/2022-05-19-the-new-github-issues-may-19th-update
@david-allison
Copy link
Contributor Author

Fixed conflicts. Is anything required on my end to get this merged?

Copy link

@jeffwidman jeffwidman left a comment

Choose a reason for hiding this comment

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

This seems like the sane default.

I realize it's technically a breaking change so may require a v6, but I doubt many users have workflow that changes base on the close-issue-reason attribute so blast radius is probably pretty small... could also argue that the previous value was simply "unset" and this isn't so much a breaking change as simply a "enhancement" of setting the value...

@Ronaldbk Ronaldbk mentioned this pull request Sep 20, 2022
@luketomlinson luketomlinson merged commit 02e44c8 into actions:main Sep 20, 2022
5 checks passed
@david-allison david-allison deleted the fix-789 branch Sep 20, 2022
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.

Make not_planned the default close-issue-reason
3 participants