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.

Sign up for GitHub

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

Jump to bottom

chore: update .releaserc #1575

Merged
merged 1 commit into from
Apr 13, 2023
Merged

chore: update .releaserc #1575

merged 1 commit into from
Apr 13, 2023

Conversation

boneskull
Copy link
Contributor

This changes three things in .releaserc (which controls how semantic-release works):

  1. Switched the preset from angular to conventionalcommits to match our changelog and commitlint configurations.
  2. Removed the rule which causes chore-type commits to be released as patch versions. This was causing many unnecessary releases.
  3. Hide chore- and refactor-type commits from the changelog. These are typically not useful to end users.

@KazuCocoa I see that you explicitly added the configuration to make chore-type commits cause patch releases, but I could not find any reasoning/intent as the original PR text (#1458) was empty.

@boneskull boneskull self-assigned this Apr 7, 2023
@KazuCocoa
Copy link
Member

Around https://appium.slack.com/archives/C02956V3H/p1648278185677869 is the original discussion for refactor/chore

@boneskull
Copy link
Contributor Author

OK, so it looks like @mykola-mokhnach asked about it, and it was changed. But per convention, chore is not supposed to trigger a new release. If we need to trigger a release, then the commit should have type fix or feat.

chore generates way too many releases, as it'd be near a 1:1 relationship between releases and PRs. Some chore tasks modify things that aren't user-facing (such as dev dep updates) and such changes needn't be published.

FWIW: When Renovate updates a production dependency, it uses the fix type; dev deps are chore type.

@jlipps
Copy link
Member

jlipps commented Apr 10, 2023

Regardless of what I might or might not have said about this earlier, if anything, I too think we should not release packages for chore commits. If we really want to release a package because of a commit, it's probably not actually a chore. I think chore commits should just be released whenever the next release happens afterward.

KazuCocoa
KazuCocoa reviewed Apr 11, 2023
View reviewed changes
.releaserc Outdated
{"type": "chore", "section": "Miscellaneous Chores"},
{"type": "refactor", "section": "Code Refactoring"},
{"type": "chore", "section": "Miscellaneous Chores", "hidden": true},
{"type": "refactor", "section": "Code Refactoring", "hidden": true},
Copy link
Member

Choose a reason for hiding this comment

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

Can hide only chore? (personally only hiding renovate would be preferred though)

So far, past refactoring tasks occasionally caused regressions/performance degrade (element lookup) we noticed by user reports. Keeping possible production code change in the changelog may help to guess what change might affect some behavior

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I suppose, but that information can be gleaned from other sources. I'll revert it since I don't care that much

@boneskull boneskull force-pushed the boneskull/semantic-release-fix branch from a68e241 to 050f117 Compare April 11, 2023 18:33
@boneskull
Copy link
Contributor Author

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

KazuCocoa
KazuCocoa reviewed Apr 12, 2023
View reviewed changes
Copy link
Member

@KazuCocoa KazuCocoa left a comment

Choose a reason for hiding this comment

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

I'm ok to go with this merge (mostly to reduce renovate's chore release..)

I like to keep chore and refactor in the changelog for future debugging mainly (to avoid reading commit history first) but don't have strong opinion.

@boneskull boneskull force-pushed the boneskull/semantic-release-fix branch from 050f117 to d0664bf Compare April 13, 2023 20:02
@boneskull
chore: update .releaserc
3aee823 
This changes three things in `.releaserc` (which controls how `semantic-release` works):

1. Switched the preset from `angular` to `conventionalcommits` to match our changelog and commitlint configurations.
2. Removed the rule which causes `chore`-type commits to be released as patch versions.  This was causing many unnecessary releases.
3. Hide `chore`- and `refactor`-type commits from the changelog.  These are typically not useful to end users.
@boneskull boneskull force-pushed the boneskull/semantic-release-fix branch from d0664bf to 3aee823 Compare April 13, 2023 20:03
@github-actions
Copy link
Contributor

PR Preview Action 2a652922e
🚀 Deployed preview to https://appium.github.io/appium-xcuitest-driver/pr-preview/pr-1575/
on branch docs-site at 2023-04-13 20:03 UTC

@boneskull boneskull merged commit b2b95e3 into master Apr 13, 2023
@boneskull boneskull deleted the boneskull/semantic-release-fix branch April 13, 2023 20:13
@github-actions
Copy link
Contributor

🎉 This PR is included in version 4.21.32 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

@KazuCocoa KazuCocoa KazuCocoa left review comments

@jlipps jlipps Awaiting requested review from jlipps

@mykola-mokhnach mykola-mokhnach Awaiting requested review from mykola-mokhnach

Assignees

@boneskull boneskull

Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@boneskull @KazuCocoa @jlipps