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

Set up versioning #22

Merged
merged 2 commits into from
Sep 19, 2024
Merged

Set up versioning #22

merged 2 commits into from
Sep 19, 2024

Conversation

dougollerenshaw
Copy link
Owner

@dougollerenshaw dougollerenshaw commented Sep 19, 2024

Sets up versioning and mechanisms for auto-incrementing the version.

Addresses #7

Uses bumpversion combined with github actions to automatically update the version when the PR is merged and to add a preview of the expected version number in the PR comment. To use this system:

  • For most changes, you don't need to do anything special. The version will automatically bump at the patch level.
  • For minor changes, use a commit message starting with feat: or include #minor in the PR title.
  • For major changes, include BREAKING CHANGE: in the commit body or #major in the PR title.
  • If you merge a PR and realize you wanted a different version bump, you can manually push a commit to main with a message like bump: version 1.2.3 → 1.3.0 to adjust as needed.

@dougollerenshaw dougollerenshaw changed the title Setup versioning Set up versioning Sep 19, 2024
@dougollerenshaw dougollerenshaw merged commit f42fa74 into main Sep 19, 2024
5 of 6 checks passed
@dougollerenshaw dougollerenshaw deleted the setup_versioning branch September 19, 2024 21:07
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.

1 participant