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

🛠 Repo: Don't create release PR until there's a user-facing change? #5190

Open
5 tasks done
JoshuaKGoldberg opened this issue Aug 6, 2024 · 3 comments
Open
5 tasks done
Labels
area: repository tooling concerning ease of contribution core-team issues which must be handled by Mocha's core team

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Aug 6, 2024

Tooling Suggestion Checklist

Overview

Following #5186: we're seeing a release-it PR created when the only commits on main are from chore: ... commits (### 🧹 Chore). #5189 is an example.

I'd think we'd want to skip creating the PR until there's something like a feat or fix that impacts users. Is such a thing doable with release-it?

Additional Info

A note from @voxpelli's #5189 (comment):

@JoshuaKGoldberg We can remove parts by changing / adding / removing to

"changelog-sections": [
{ "type": "feat", "section": "🌟 Features", "hidden": false },
{ "type": "fix", "section": "🩹 Fixes", "hidden": false },
{ "type": "docs", "section": "📚 Documentation", "hidden": false },
{ "type": "chore", "section": "🧹 Chores", "hidden": false },
{ "type": "perf", "section": "🧹 Chores", "hidden": false },
{ "type": "refactor", "section": "🧹 Chores", "hidden": false },
{ "type": "test", "section": "🧹 Chores", "hidden": false },
{ "type": "build", "section": "🤖 Automation", "hidden": false },
{ "type": "ci", "section": "🤖 Automation", "hidden": true }
],

@JoshuaKGoldberg JoshuaKGoldberg added area: repository tooling concerning ease of contribution status: in triage a maintainer should (re-)triage (review) this issue labels Aug 6, 2024
@voxpelli
Copy link
Member

voxpelli commented Aug 6, 2024

If we change to "hidden": false we can hide it from the release notes

The default for release-please is actually:

    { type: 'feat', section: 'Features' },
    { type: 'feature', section: 'Features' },
    { type: 'fix', section: 'Bug Fixes' },
    { type: 'perf', section: 'Performance Improvements' },
    { type: 'revert', section: 'Reverts' },
    { type: 'docs', section: 'Documentation', hidden: true },
    { type: 'style', section: 'Styles', hidden: true },
    { type: 'chore', section: 'Miscellaneous Chores', hidden: true },
    { type: 'refactor', section: 'Code Refactoring', hidden: true },
    { type: 'test', section: 'Tests', hidden: true },
    { type: 'build', section: 'Build System', hidden: true },
    { type: 'ci', section: 'Continuous Integration', hidden: true }

@JoshuaKGoldberg
Copy link
Member Author

hide it from the release notes

Ah, we've included chores in the release notes for previous ones...

@voxpelli
Copy link
Member

voxpelli commented Aug 6, 2024

Yeah, I would have wanted a way to say "Don't trigger, but include when triggered by something else"

I would ultimately want to swap to release-it/release-it#1126, whenever I get time to implement that :/

@JoshuaKGoldberg JoshuaKGoldberg added core-team issues which must be handled by Mocha's core team and removed status: in triage a maintainer should (re-)triage (review) this issue labels Aug 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: repository tooling concerning ease of contribution core-team issues which must be handled by Mocha's core team
Projects
None yet
Development

No branches or pull requests

2 participants