pagekey-semver
This is a simple, opinionated semantic versioning tool.
Check out the docs site (coming soon) or the docs site source to learn more.
Getting Started
- Install the package
pip install pagekey-semver
- Run the dry run to see what will happen.
pagekey-semver plan
- Run it for real to tag and push!
pagekey-semver apply
Usage
As you'll see below, it's highly recommended to set the SEMVER_TOKEN variable to your push credential, as well as SEMVER_USER if applicable for your Git hosting platform.
GitHub Actions
The simplest way to get started is to paste the following workflow into a file such as .github/workflows/ci.yml.
name: Run semantic version process.
on: [push]
jobs:
version:
uses: pagekey/semver/.github/workflows/semver.yml@main
If you want to specify which user is used to push, you can use the following snippet. You must create the SEMVER_USER and SEMVER_TOKEN secrets. You can use a GitHub Personal Access Token set as a repo or organization secret. If you'd rather not use your personal account for the PAT, you can use a bot account.
name: Run semantic version process.
on: [push]
jobs:
version:
uses: pagekey/semver/.github/workflows/semver.yml@main
with:
SEMVER_USER: ${{ secrets.SEMVER_USER }}
SEMVER_TOKEN: ${{ secrets.SEMVER_TOKEN }}
Beware that GitHub does not trigger a pipeline on tags pushed from Actions (or at least, I couldn't figure out how to get it to do that.)
If you want to trigger another workflow only when a tag has been created, you can use the following, combining needs and if to check:
jobs:
# ...
# omitting inclusion of semver.yml shown above
# ...
publish:
needs: version
if: ${{ needs.version.outputs.semver_release_occurred == 'true' }}
steps:
# Do anything that should only occur on new tags, such as publishing/deploying your code.
- name: Checkout code
uses: actions/checkout@v4
GitLab CI/CD
GitLab CI/CD is a bit more straightforward than GitHub Actions for this package. There is no restriction on running pipelines that have been created automatically, so a tag pipeline will run when the package pushes. Use the following snippet in your .gitlab-ci.yml file to get started. Be sure to set SEMVER_USER and SEMVER_TOKEN. For user, you can use oauth2, gitlab-ci-token, or your username. For the token, use a personal or group access token.
Note that only and except are deprecated, but are included here for simplicity. You can migrate to rules if you would like.
stages:
- version
semver-dry-run:
stage: version
image: python:3.10
except: [main, tags]
script:
- pip install pagekey-semver
- pagekey-semver plan
semver:
stage: version
image: python:3.10
only: [main]
script:
- pip install pagekey-semver
- pagekey-semver apply
Philosophy
This is an opinionated version of Semantic Release that loosely follows the guidelines at semver.org. It puts practicality above all theory. There is no special treatment of "pre-releases", versions prior to v1.0.0. Everything behaves the same: patch prefixes increment the third number, minor patches increment the middle number, and major prefixes increment the first number. If there are multiple prefixes, the prefix with the greatest precedence is applied. If you don't like the default settings, you can override them using the configuration format below.
This package is intended to run on a Linux system with the bash shell installed.
Configuration
See here for more information on how to configure the tool.
Metadata
Release files for pagekey-semver 0.3.29
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pagekey_semver-0.3.29.tar.gz | 15.9 kB | Without provenance | Details for pagekey_semver-0.3.29.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pagekey_semver-0.3.29-py3-none-any.whl | Python 3 | none | any | Details for pagekey_semver-0.3.29-py3-none-any.whl |
Total release size: 38.3 kB
Release files / pagekey_semver-0.3.29.tar.gz
| Download URL | pagekey_semver-0.3.29.tar.gz |
|---|---|
| Size | 15.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
594cb7f75e6974f8ad1adbb8f459fbb2a8bb523b7338d6ae6cfd4821f7c48acd
|
|
BLAKE2b-256 checksum How to use checksums |
7ae5446ad07095fefce455ebffeb34114f6533c48e6cfccea340278c4fece9e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1025-azure
|
Release files / pagekey_semver-0.3.29-py3-none-any.whl
| Download URL | pagekey_semver-0.3.29-py3-none-any.whl |
|---|---|
| Size | 22.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
30d07db89c5036979492e314a5003677d445a4dfdf31e7779e2ccd058ebf4a03
|
|
BLAKE2b-256 checksum How to use checksums |
a83ace59297305beb426dea85a18c13a04a56e24d57121fc472dc70369ace878
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1025-azure
|
Security for pagekey-semver 0.3.29
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.