Skip to main content

gh-semantic-release

Trigger a semantic release with the click of a button

THIS PROJECT IS CURRENTLY UNDER DEVELOPMENT

Concept

  • A tool to trigger a GitHub release
    • CLI tool
    • GitHub action published
    • GitHub workflow template provided
  • Parse semantic commits to generate structured changelog
  • A GitHub workflow template will be provided
  • Automatic version bump

Workflows

  1. Trigger a workflow dispatch with a release name to automatically generate a new GitHub release.

    • The version will be bumped based on a configurable heuristic (breaking => major, feat => minor, etc.)
    • The changelog/release summary will be constructed from the parsed commits
  2. Configurable via pyproject.toml

    [tool.gh-semantic-release]
    types = ["build", "chore", "ci", "docs", "feat"]  # ...
    
  3. Installed via pypi

    Write your own bespoke release behavior using either the CLI or by extending scottzach1.semantic_release with your own custom python code.

Metadata

Release files for gh-semantic-release 0.0.1

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

Source distribution (sdist)

Source distribution for gh-semantic-release 0.0.1
File Size Uploaded
gh_semantic_release-0.0.1.tar.gz 2.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gh-semantic-release 0.0.1
File Interpreter ABI Platform
gh_semantic_release-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 5.5 kB

Release files / gh_semantic_release-0.0.1.tar.gz

Download URL gh_semantic_release-0.0.1.tar.gz
Size 2.5 kB
Tags Source
SHA-256 checksum
How to use checksums
703fbc0f6c8f22787f751727727aaf676a4de7c50315a7670245c859130f0bd6
BLAKE2b-256 checksum
How to use checksums
64ab55bf5c7e21cbd38e5393f1a7d8fe5729f18920d1a0bfb8fdcdc013dfaa77
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 19, 2025.

Transparency log

Release files / gh_semantic_release-0.0.1-py3-none-any.whl

Download URL gh_semantic_release-0.0.1-py3-none-any.whl
Size 3.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f0b6a5ee552c284e73f94a0bcbadb03fa2eee92487fd489d1a4b5c8a3d4ccbb
BLAKE2b-256 checksum
How to use checksums
d72e757867d139a4d322afa6247fedf6c14aec14a5ae1b777c3726c08e859e16
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 19, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

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