Skip to main content

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

  1. Install the package
pip install pagekey-semver
  1. Run the dry run to see what will happen.
pagekey-semver plan
  1. 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

Follow these steps to use PageKey Semver with GitHub Actions.

  1. Generate a GitHub Personal Access Token. Follow this guide if you're not sure how.

  2. Add the token to your repo or organization as the SEMVER_TOKEN secret. See this guide for more info on how to do that.

  3. Add a SEMVER_USER secret containing your username. If you'd rather not use your personal account, use a bot account.

  4. Add the following workflow in your repo at .github/workflows/ci.yml:

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 }}

GitLab CI/CD

Coming soon.

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.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pagekey-semver 0.3.18
File Size Uploaded Provenance Actions
pagekey_semver-0.3.18.tar.gz 13.7 kB Without provenance Details for pagekey_semver-0.3.18.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pagekey-semver 0.3.18
File Interpreter ABI Platform Actions
pagekey_semver-0.3.18-py3-none-any.whl Python 3 none any Details for pagekey_semver-0.3.18-py3-none-any.whl

Total release size: 33.8 kB

Release files / pagekey_semver-0.3.18.tar.gz

Download URL pagekey_semver-0.3.18.tar.gz
Size 13.7 kB
Tags Source
SHA-256 checksum
How to use checksums
022ad58633085bd44ccca4f56c067320fe108ae8415b9c62639f63be7ba667fa
BLAKE2b-256 checksum
How to use checksums
f429b8e96355e5e49d90a3a795948e5e198f81f10215de19b9f75f66546ab5fb
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.18-py3-none-any.whl

Download URL pagekey_semver-0.3.18-py3-none-any.whl
Size 20.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ad9135a17e275c71fb9468f86a10329aeb5e450ffb2eada4ac360028b938377a
BLAKE2b-256 checksum
How to use checksums
4708852dc5c8ce3794cdb8562ffa7663225588dbb4f28824ca639aab53f59541
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.18

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.

Release history Release notifications | RSS feed

This release

0.3.18 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page