Skip to content

chore(CI): add automatic release #314

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
wants to merge 2 commits into from
Closed

chore(CI): add automatic release #314

wants to merge 2 commits into from

Conversation

MichaelDeBoey
Copy link
Member

@MichaelDeBoey MichaelDeBoey commented Oct 12, 2022

@eslint-community/eslint-tsc In order to make the automatic release work, we should add the NPM_TOKEN secret in the Action secret settings.

I think it's best to set a PAT for the eslint-community-bot npm user btw.


This branch depends on #313

Closes #301


This PR is inspired by what I did for @mysticatea/eslint-plugin in eslint-community/eslint-plugin-mysticatea#8

@MichaelDeBoey MichaelDeBoey requested review from a team October 12, 2022 02:13
@MichaelDeBoey MichaelDeBoey force-pushed the patch-2 branch 2 times, most recently from 2b33b28 to 3cf95ac Compare October 12, 2022 15:32
@nzakas
Copy link

nzakas commented Oct 12, 2022

I added an npm automation token as NPM_TOKEN at the organization level. To be safe it’s not enabled for any repos. You can enable it just for the repos that need it.

@bmish
Copy link
Member

bmish commented Oct 12, 2022

@MichaelDeBoey how will the automatic releases work? When will they happen? And what if we want to do a single release with multiple changes?

@MichaelDeBoey
Copy link
Member Author

MichaelDeBoey commented Oct 13, 2022

I added an npm automation token as NPM_TOKEN at the organization level.

@nzakas Thanks! 🙏


how will the automatic releases work? When will they happen?

@bmish semantic-release will take care of the release on every commit that's done to the main/next/alpha/beta branch
It will look at the commit message & release a patch version for fix, a minor version for feat & a major version for every commit that has a BREAKING CHANGE in their body
More info on how they work, can be found at:

what if we want to do a single release with multiple changes?

You can create pre-releases when pushing to the alpha/beta branch. Each commit will still be released, but not for people who install the package normally, only for people who use the -alpha.X/-beta.X suffix or alpha/beta token (like npm install eslint-plugin-eslint-plugin@alpha).
Have a look at how this is working for testing-library-eslint-config:

@bmish
Copy link
Member

bmish commented Oct 13, 2022

Should we add the github badge so people know things will be released automatically? https://github.com/semantic-release/semantic-release#badge

@bmish
Copy link
Member

bmish commented Oct 13, 2022

Should we get rid of release-it at this point to avoid having multiple systems in place for releasing? Added here: #131

@bmish
Copy link
Member

bmish commented Oct 13, 2022

Is this compatible with the conventional commits we currently use? #221

@MichaelDeBoey
Copy link
Member Author

Should we add the github badge so people know things will be released automatically?

Was going to cleanup the badges in a separate PR

Should we get rid of release-it at this point to avoid having multiple systems in place for releasing?

Indeed a good idea to remove it

Is this compatible with the conventional commits we currently use?

Yes it very much is!
The docs I referenced are even mentioning commitizen & commitlint

Tools such as commitizen or commitlint can be used to help contributors and enforce valid commit messages.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants