https://github.com/djpugh/mkdocs_github_changelog
mkdocs extension to autogenerate changelog from github releases
https://github.com/djpugh/mkdocs_github_changelog
changelog-generator github-releases mkdocs mkdocs-plugin
Last synced: 4 months ago
JSON representation
mkdocs extension to autogenerate changelog from github releases
- Host: GitHub
- URL: https://github.com/djpugh/mkdocs_github_changelog
- Owner: djpugh
- License: mit
- Created: 2023-12-20T10:23:27.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T21:40:44.000Z (about 1 year ago)
- Last Synced: 2025-01-30T16:43:45.867Z (about 1 year ago)
- Topics: changelog-generator, github-releases, mkdocs, mkdocs-plugin
- Language: Python
- Homepage: https://djpugh.github.io/mkdocs_github_changelog/
- Size: 627 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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 -- ``
## 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 ``..``. Increment the:
* ```` version when you make incompatible API changes,
* ```` version when you add functionality in a backwards-compatible manner, and
* ```` 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 ..`` and then make sure to push that tag with ``git push origin ..``,
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``.