chore: setup semantic-release

editorconfig-checker / editorconfig-checker.javascript

A tool to verify that your files are in harmony with your .editorconfig

https://editorconfig-checker.github.io/

MIT License

70 stars 10 forks source link

chore: setup semantic-release #406

Closed theoludwig closed 7 months ago

theoludwig commented 7 months ago

Fixes #393

This PR changes:

Setup commitlint with Conventional Commits.
Setup semantic-release to get automatic releases and changelog when merging on master branch (and optionnaly prerelease on betabranch if ever needed).
Rename current CHANGELOG file to tell that it's legacy, and now changelog will be in GitHub Releases.
Update README badges as they were out of date.

Edit: When merging this PR, we need to setup NPM_TOKEN in settings of the repo, to be able to publish on npm.

theoludwig commented 7 months ago

Looks good to me - I think the only issue I see is how we can enforce semantic commits across the community/contributions.

We could squash and rename the commit message in case it doesn't match or have a CI job which doesn't let us merge in such a case.

Yeah, squashing the commits work. :+1: Also, we have a lint:commit npm scripts that is run in CI to check if the commits follows the convention. We might need to add a CONTRIBUTING.md file so it is clearer for future contributors.

Edit: I've added a CONTRIBUTING.md file (based on my other GitHub projects), it is simple, but at least define some "conventions"/guidelines to follow when contributing. Also created the Issues and PRs templates.

theoludwig commented 7 months ago

Thank you for your fast reactivity, and your willness, to continue to make editorconfig-checker awesome, even if you might not use it as much as before. :heart: I'm glad to help. And currently learning Rust to try to continue the mission for https://github.com/mstruebing/editorconfig-core-rust, it might still take time, but will eventually do it.

mstruebing commented 7 months ago

Thanks so much, I have no vetos to this PR. Should I add an npm token from myself or should I add you to the npm repository so that you are able to fiddle around with it yourself?

theoludwig commented 7 months ago

Should I add an npm token from myself or should I add you to the npm repository so that you are able to fiddle around with it yourself?

Both work, as you want. You could add my npm account: https://www.npmjs.com/~theoludwig to the npm package.

mstruebing commented 7 months ago

I've send you an invite

theoludwig commented 7 months ago

I've send you an invite

Perfect, I accepted it. However I just find out, I don't have the permissions to change Actions secrets on this GitHub repository in the settings. :smile:

mstruebing commented 7 months ago

@theoludwig Can you check again? :)

theoludwig commented 7 months ago

@theoludwig Can you check again? :)

Good. :+1: I've added my NPM_TOKEN, will be able to test if it works for next release.

github-actions[bot] commented 5 months ago

:tada: This PR is included in version 5.1.3 :tada:

The release is available on:

Your semantic-release bot :package::rocket: