# 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``.
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-github-changelog",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.7",
"maintainer_email": "David J Pugh <djpugh@gmail.com>",
"keywords": "mkdocs,mkdocs-plugin,github,changelog,documentation",
"author": "",
"author_email": "David J Pugh <djpugh@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a7/c9/58c78c627de3a82fe5ce28be0b71f029323bf22505bf238fc13ae73af8d6/mkdocs_github_changelog-0.1.0.tar.gz",
"platform": null,
"description": "# mkdocs_github_changelog\n\n\nmkdocs extension to autogenerate changelog from github\n\n\n## Introduction\n\n\n## Contributing\n\nTo see the contribution guidelines, see [docs/source/developing/index.md](docs/source/developing/index.md).\n\n## Setting up for development\n\nCreate a virtual environment.\nInstall the package using ``pip install -e .[dev]``\n\n\nThen add code to the package as appropriate - submodules can be created under ``src/mkdocs_github_changelog``\nTests can be added to the tests folder\n\n\n\n### CI\n\nThere are a set of CI checks:\n\n* lint: ``nox -t lint``\n* test: ``nox -t test``\n* build: ``nox -t build``\n\nspecific subfolders can be passed to the test tag in nox: ``nox -t test -- <subfolder1> <subfolder2>``\n\n\n\n\n## Versioning\n\nIt is important to track and version code, and to aid that with the python packages and models, ``setuptools_scm`` is used.\nThis links the version reported at ``__version__`` to the git tag (+ commit hash if appropriate), to reduce the amount of\nplaces that need editing when changing versions.\n\nFor describing versions we are using semantic versioning ``<major>.<minor>.<patch>``. Increment the:\n\n* ``<major>`` version when you make incompatible API changes,\n* ``<minor>`` version when you add functionality in a backwards-compatible manner, and\n* ``<patch>`` version when you make backwards-compatible bug fixes.\n\nThere are also codes for pre-releases and other descriptions (see https://semver.org/)\n\nTo create a version, use ``git tag <major>.<minor>.<patch>`` and then make sure to push that tag with ``git push origin <major>.<minor>.<patch>``,\nor an equivalent tagging tool (e.g. Github releases).\n\n\n\n\n\n------------\n\nRepo created from nskit.recipes.python.package:PackageRecipe (version 0.0.post1.dev14+g7e85d99.d20231220) using ``nskit``.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "mkdocs extension to autogenerate changelog from github",
"version": "0.1.0",
"project_urls": {
"repository": "https://github.com/djpugh/mkdocs_github_changelog"
},
"split_keywords": [
"mkdocs",
"mkdocs-plugin",
"github",
"changelog",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "981a2c589b594ef6d9ff55e557df83d32cd5a458a5d5d164051127c6e98169a1",
"md5": "8f51c42750766ab8d01d7e81fdf0583d",
"sha256": "9981ddeb16a029e31693a47ffffed19a61496876b737c0deccef5cd76464637a"
},
"downloads": -1,
"filename": "mkdocs_github_changelog-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f51c42750766ab8d01d7e81fdf0583d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.7",
"size": 9947,
"upload_time": "2023-12-26T19:20:54",
"upload_time_iso_8601": "2023-12-26T19:20:54.899800Z",
"url": "https://files.pythonhosted.org/packages/98/1a/2c589b594ef6d9ff55e557df83d32cd5a458a5d5d164051127c6e98169a1/mkdocs_github_changelog-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7c958c78c627de3a82fe5ce28be0b71f029323bf22505bf238fc13ae73af8d6",
"md5": "5b8805bb44c0f4e64680b96f581018ec",
"sha256": "aa2b354620500d03de35a7ef6ddd6f9b14f55c49678684e5dd191853e0a69354"
},
"downloads": -1,
"filename": "mkdocs_github_changelog-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5b8805bb44c0f4e64680b96f581018ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.7",
"size": 26621,
"upload_time": "2023-12-26T19:20:56",
"upload_time_iso_8601": "2023-12-26T19:20:56.124623Z",
"url": "https://files.pythonhosted.org/packages/a7/c9/58c78c627de3a82fe5ce28be0b71f029323bf22505bf238fc13ae73af8d6/mkdocs_github_changelog-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-26 19:20:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "djpugh",
"github_project": "mkdocs_github_changelog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-github-changelog"
}
JSON
