Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
wawiesel committed Feb 15, 2024
1 parent 3669198 commit 202d86c
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,20 @@ Follow these [guidelines](https://cbea.ms/git-commit/) for commit messages.
### Version updates

OLM uses [semantic versioning](https://semver.org/). You should commit the
relevant code with the usual description commit message. Then run
`bumpversion major`, `bumpversion minor`, or `bumpversion patch` which will
automatically create a new commit message and version tag. When you push you
need to `git push --tags` or configure your repo to always push tags:
relevant code with the usual description commit message.

Then run

- `bumpversion patch` if you are fixing a bug
- `bumpversion minor` if you are adding a new feature
- `bumpversion major` if you are breaking backwards compatibility

When you push you need to `git push --tags` or configure your repo to always push tags:

```
#.git/config
[remote "origin"]
push = +refs/heads/*:refs/heads/*
push = +refs/tags/*:refs/tags/*
```

Expand Down

0 comments on commit 202d86c

Please sign in to comment.