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

Versioning / release conecpt #21

Open
dweber019 opened this issue Feb 16, 2022 · 3 comments
Open

Versioning / release conecpt #21

dweber019 opened this issue Feb 16, 2022 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@dweber019
Copy link
Collaborator

As we start from the ground up, we should have versioning/release concept regarding added rules to support transparency for users.

E.g.
Rules with severity error should cause breaking change (major)
Rules with severity warn should cause feature change (minor)

@dweber019 dweber019 self-assigned this Feb 16, 2022
@dweber019 dweber019 added the enhancement New feature or request label Feb 16, 2022
@dweber019
Copy link
Collaborator Author

Proposal.

If new rules are implemented, the version will be bumped accordingly.

Severity Version
error MAJOR
warn MINOR
info MINOR
hint MINOR

You can check https://github.com/phips28/gh-action-bump-version on how to cause a certain version.

MAJOR => "BREAKING CHANGE" in commit message
MINOR => "feat" in commit message e.g. "feat: my new warn rule"
PATCH => everything else is a patch version. E.g. fixes which are none breaking "fix: correct error message"

Generally we should use https://www.conventionalcommits.org/en/v1.0.0/ for our commit messages.

@dweber019
Copy link
Collaborator Author

@leubedane what do you think?

@dweber019
Copy link
Collaborator Author

We could enforce message format with https://github.com/marketplace/actions/commit-linter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant