Skip to content

Commit

Permalink
Remove Python Semantic Versioning from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sahcim committed Jul 30, 2024
1 parent f036ca3 commit a326651
Showing 1 changed file with 1 addition and 17 deletions.
18 changes: 1 addition & 17 deletions {{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,29 +121,13 @@ $ ./bump_version.sh minor
$ ./bump_version.sh major
$ ./bump_version.sh patch
# to see what is going to change run:
$ ./bump_versemantic-release version --patch --printsion.sh --dry-run major
$ ./bump_version.sh --dry-run major
```
Script updates **VERSION** file and setup.cfg automatically uses that version.

You can configure it to update version string in other files as well - please check out the bump2version configuration file.
{% endif -%}

{%- if cookiecutter.versioning == "Python Semantic Release" %}
If using GitHub, you can manually trigger version check and release in GitHub Actions web GUI. It will also automatically trigger based on your commits.

You can also trigger it manually using:
```bash
# dry-run to preview changes
$ semantic-release --noop version
# dry-run to preview only the new version
$ semantic-release version --print
# to apply new version and without pushing
$ semantic-release version --no-push
# to apply new version and push
$ semantic-release version
```
{% endif -%}

{% if cookiecutter.ci == "GitLab" %}

On GitLab CI, you can build development, test package and upload it manually as minor.major.patch-dev{BUILD_NUMBER} to PIP registry.
Expand Down

0 comments on commit a326651

Please sign in to comment.