eXist-db / xst

Command line tool to interact with exist-db instances
https://npmjs.com/@existdb/xst
MIT License
17 stars 4 forks source link

build: move to conventional commits #48

Closed line-o closed 1 year ago

line-o commented 1 year ago

By default semantic-release still uses the angular commit message format. This PR switches the commit analyser to use conventional commits. The main advantage is that it allows to signal breaking changes by adding an exclamation mark after the scope.

fix!: this is a breaking change 

Whereas with angular commit message format one would need to write

fix: this is a breaking change

BREAKING CHANGE: Description what is breaking and how to mitigate that.

And it happened to me more than once that I forgot to add the colon after BREAKING CHANGE and the commit was published as a patch!

line-o commented 1 year ago

(META) @duncdrum I would like to add you as a reviewer but you are not in the list. Can I change that, and if yes how?

duncdrum commented 1 year ago

@line-o good idea on conventional commits. If you add this repo to the orgs frontend / node whatever team. I should be able to review.

This is good to merge

duncdrum commented 1 year ago

I don’t have write access so I can’t merge, otherwise good to go

line-o commented 1 year ago

I am in working on linting commits in ci. I would like to have that ready as part of this PR. Turns out I used a wrong scope myself unknowingly (it's docs not doc). But for this to work now I will need to find the added PRs for both push and pull_request events... again. Last time we ended up splitting the actions per event because the info we get is so different.

line-o commented 1 year ago

Ah and the readme needs a contributing section.

line-o commented 1 year ago

Now you should be able to merge PRs. But please have a look first.

line-o commented 1 year ago

Specifically @duncdrum could you checkout this PR and follow the instructions to get the commit hooks working locally? That would be great to have validation that it works as intended.

line-o commented 1 year ago

In my testing this was the case but I have it setup already.

github-actions[bot] commented 1 year ago

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

The release is available on:

Your semantic-release bot :package::rocket: