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

Add Release-please configuration #19

Merged
merged 3 commits into from
Apr 8, 2024

Conversation

YuiYukihira
Copy link
Contributor

@YuiYukihira YuiYukihira commented Apr 7, 2024

Added Release-Please configuration to simplify releases to just clicking the merge button on a PR. It bases the version off of your commits using
Conventional Commits. This also allows it to generate a changelog as well.

To ensure that commits following the convention, a git hook, using husky, has also been added that prevents commits from being made unless they follow the convention. Git hooks can be skipped using CLI flags to ensure full conformity, a workflow has been added to ensure their correctness and to run a quick check of the code.

You'll need to configure some repo settings, so let me know if you want to merge this and I can run you through them.

Added [Release-Please](https://github.com/googleapis/release-please)
configuration to simplify releases to just clicking the merge button on
a PR. It bases the version off of your commits using
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
This also allows it to generate a changelog as well.

To ensure that commits following the convention, a git hook, using
[husky](https://typicode.github.io/husky/), has also
been added that prevents commits from being made unless they follow the
convention. Git hooks can be skipped using CLI flags to ensure full
conformity, a workflow has been added to ensure their correctness and to
run a quick check of the code.

Signed-off-by: Lucy Ekaterina <[email protected]>
@jparkhouse jparkhouse self-requested a review April 7, 2024 17:49
@jparkhouse
Copy link
Owner

I'll chat to you about this in a spare work moment - seems complex

jparkhouse
jparkhouse previously approved these changes Apr 8, 2024
@jparkhouse jparkhouse merged commit dca8854 into jparkhouse:main Apr 8, 2024
1 of 2 checks passed
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.

2 participants