mkdocs extension to autogenerate changelog from github
Project description
# mkdocs_github_changelog
mkdocs extension to autogenerate changelog from github
## Introduction
## Contributing
To see the contribution guidelines, see [docs/source/developing/index.md](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.
Project details
Release history Release notifications | RSS feed
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
Hashes for mkdocs_github_changelog-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa2b354620500d03de35a7ef6ddd6f9b14f55c49678684e5dd191853e0a69354 |
|
MD5 | 5b8805bb44c0f4e64680b96f581018ec |
|
BLAKE2b-256 | a7c958c78c627de3a82fe5ce28be0b71f029323bf22505bf238fc13ae73af8d6 |
Hashes for mkdocs_github_changelog-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9981ddeb16a029e31693a47ffffed19a61496876b737c0deccef5cd76464637a |
|
MD5 | 8f51c42750766ab8d01d7e81fdf0583d |
|
BLAKE2b-256 | 981a2c589b594ef6d9ff55e557df83d32cd5a458a5d5d164051127c6e98169a1 |