mkdocs_github_changelog
mkdocs extension to autogenerate changelog from github
Introduction
Contributing
To see the contribution guidelines, see docs/source/developing/index.md.
Setting up for development
Create a virtual environment.
Install the package using pip install -e .[dev]
Then add code to the package as appropriate - submodules can be created under src/mkdocs_github_changelog
Tests can be added to the tests folder
CI
There are a set of CI checks:
- lint:
nox -t lint - test:
nox -t test - build:
nox -t build
specific subfolders can be passed to the test tag in nox: nox -t test -- <subfolder1> <subfolder2>
Versioning
It is important to track and version code, and to aid that with the python packages and models, setuptools_scm is used.
This links the version reported at __version__ to the git tag (+ commit hash if appropriate), to reduce the amount of
places that need editing when changing versions.
For describing versions we are using semantic versioning <major>.<minor>.<patch>. Increment the:
<major>version when you make incompatible API changes,<minor>version when you add functionality in a backwards-compatible manner, and<patch>version when you make backwards-compatible bug fixes.
There are also codes for pre-releases and other descriptions (see https://semver.org/)
To create a version, use git tag <major>.<minor>.<patch> and then make sure to push that tag with git push origin <major>.<minor>.<patch>,
or an equivalent tagging tool (e.g. Github releases).
Repo created from nskit.recipes.python.package:PackageRecipe (version 0.0.post1.dev14+g7e85d99.d20231220) using nskit.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_github_changelog-0.1.1.tar.gz.
File metadata
- Download URL: mkdocs_github_changelog-0.1.1.tar.gz
- Upload date:
- Size: 32.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
47fe73b428d991dab24932614bc9fc6581d63be0352271661d1b195d2a6d2034
|
|
| MD5 |
98b3cd71b4d4a493e988cb22a7a1f116
|
|
| BLAKE2b-256 |
8b3c3e4d384e51ab1311468d7beca748d23867d85c0cc028e364d7b60b31792c
|
Provenance
The following attestation bundles were made for mkdocs_github_changelog-0.1.1.tar.gz:
Publisher:
pipeline.yaml on djpugh/mkdocs_github_changelog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_github_changelog-0.1.1.tar.gz -
Subject digest:
47fe73b428d991dab24932614bc9fc6581d63be0352271661d1b195d2a6d2034 - Sigstore transparency entry: 2348200474
- Sigstore integration time:
-
Permalink:
djpugh/mkdocs_github_changelog@87655a2fa1ad45f0b6dd064e6dbc11350c571b32 -
Branch / Tag:
refs/tags/0.1.1 - Owner: https://github.com/djpugh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pipeline.yaml@87655a2fa1ad45f0b6dd064e6dbc11350c571b32 -
Trigger Event:
release
-
Statement type:
File details
Details for the file mkdocs_github_changelog-0.1.1-py3-none-any.whl.
File metadata
- Download URL: mkdocs_github_changelog-0.1.1-py3-none-any.whl
- Upload date:
- Size: 12.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13dd0a1b0a7bd567443b7c19e927174769ad3adeba991a6f6212f23c520e0006
|
|
| MD5 |
eb350339a180c057b911d130df321ab7
|
|
| BLAKE2b-256 |
269cc1630002879fda9ce25ae8cb90e9ef7a85f247f6d429ea228ba6dfd99bd4
|
Provenance
The following attestation bundles were made for mkdocs_github_changelog-0.1.1-py3-none-any.whl:
Publisher:
pipeline.yaml on djpugh/mkdocs_github_changelog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_github_changelog-0.1.1-py3-none-any.whl -
Subject digest:
13dd0a1b0a7bd567443b7c19e927174769ad3adeba991a6f6212f23c520e0006 - Sigstore transparency entry: 2348200562
- Sigstore integration time:
-
Permalink:
djpugh/mkdocs_github_changelog@87655a2fa1ad45f0b6dd064e6dbc11350c571b32 -
Branch / Tag:
refs/tags/0.1.1 - Owner: https://github.com/djpugh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pipeline.yaml@87655a2fa1ad45f0b6dd064e6dbc11350c571b32 -
Trigger Event:
release
-
Statement type:
