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

feat: make template-oss postinstall commit a breaking change for majors #180

Merged
merged 1 commit into from
Sep 21, 2022

Conversation

lukekarrys
Copy link
Contributor

When we ship engines changes we will release a semver major update
to template-oss, and the resulting dependabot PRs will get a feat!
commit to indicate that they will all need major releases as well.

This also updates the workflow to attempt to commit a subset of the
applied changes, without the workflows. The workflow will still fail, if
any changes were not committed but this allows us to have the proper
conventional commit message in the git history that we can amend when
fixing these PRs manually.

@lukekarrys
Copy link
Contributor Author

lukekarrys commented Sep 7, 2022

One thing this assumes is that template-oss will only have major releases when they make breaking changes to templated files.

I think this is a safe assumption since template-oss requires that it be installed with --save-exact, so API changes to template-oss (like changing a config name) can be released as minors and fixed up manually if necessary like we do when post-dependabot breaks.

The alternative is a well known commit footer message (eg BREAKING TEMPLATE OSS:) that we could search for in the list of released commits and run the different post-dependabot flows.

@lukekarrys lukekarrys marked this pull request as draft September 13, 2022 20:45
When we ship things like `engines` changes we will release a semver
major update to template-oss, and the resulting dependabot PRs will get
a `feat!` commit to indicate that they will all need major releases as
well. This doesn't assume anything about the contents of the breaking
change, but will instead set the correct conventional commit type and
fail the PR so that it can be followed up manually.
@lukekarrys lukekarrys marked this pull request as ready for review September 20, 2022 22:22
@lukekarrys lukekarrys merged commit 2fdcddd into main Sep 21, 2022
@lukekarrys lukekarrys deleted the lk/template-oss-postinstall branch September 21, 2022 23:53
@github-actions github-actions bot mentioned this pull request Sep 21, 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.

None yet

2 participants