Sphinx Github Changelog: Build a sphinx changelog from GitHub Releases

Deployed to PyPI Deployed to PyPI GitHub Repository Continuous Integration Documentation Coverage MIT License Contributor Covenant

Sphinx-github-changelog is a Sphinx plugin that builds a changelog section based on a repository’s GitHub Releases content.

How ? (the short version)

In your Sphinx documentation conf.py:

extensions = [
    ...,  # your other extensions
    "sphinx_github_changelog",
]

# Provide a GitHub API token:
# Pass the SPHINX_GITHUB_CHANGELOG_TOKEN environment variable to your build
# OR
sphinx_github_changelog_token = "..."

In your documentation:

.. changelog::
    :changelog-url: https://your-project.readthedocs.io/en/stable/#changelog
    :github: https://github.com/you/your-project/releases/
    :pypi: https://pypi.org/project/your-project/

See the end result for this project on ReadTheDocs.

Why ?

On the way to continuous delivery, it’s important to be able to release easily. One of the criteria for easy releases is that the release doesn’t require a commit and a Pull Request. Release Pull Requests usually include 2 parts:

  • Changing the version
  • Updating the changelog (if you keep a changelog, let’s assume you do)

Commitless releases need a way to store the version and the changelog, as close as possible to the code, but actually not in the code.

Setting aside the “version” question, sphinx-github-changelog aims at providing a good way of managing the “changelog” part:

The best solution we’ve found so far for the changelog is to store it in the body of GitHub Releases. That’s very practical for maintainers, but it may not be the first place people will look for it. As far as we’ve seen, people expect the changelog to be:

  • in the repo, in CHANGELOG.rst,
  • in the documentation.

Having the changelog in CHANGELOG.rst causes a few problems:

  • Either each PR adds its single line of changelog, but:

    • you’ll most probably run into countless merge conflicts,
    • the changelog won’t tell you which contribution was part of which release

    This reduces the interest for the whole thing.

  • Or your changelog is edited at release time. Maybe you’re using towncrier for fragment-based changelog, but you’re not doing commitless releases anymore. You could imagine that the release commit is done by your CI, but this can quickly become annoying, especially if you require Pull Requests.

But there is another way. Instead of providing the changelog, the CHANGELOG.rst file can hold a link to the changelog. This makes things much easier. sphinx-github-changelog encourages you to do that.

A complete toolbelt

Alongside sphinx-github-changelog, we suggest a few tools that play nice together:

  • setuptools-scm will compute your version in setup.py based on git tags.
  • release-drafter will keep a “Draft release” updated as you merge Pull Requests to your repository, so you just have to slightly adjust the release body, and create a tag.
  • Any Continuous Integration solution should be able to listen to new tags, and build and upload distributions to PyPI. Don’t forget to use PyPI API tokens!
  • And ReadTheDocs to host your built documentation, of course.

If you’re using all the tools above, then releasing is simple as proof-reading the draft GitHub Release and press “Publish Release”. That’s it.

Reference documentation

Extension options (conf.py)

  • changelog_github_token: GitHub API token, with read access to the repository. Defaults to the value of the environment variable SPHINX_GITHUB_CHANGELOG_TOKEN. If no value is provided, the build will still pass but the changelog will not be built, and a link to the changelog-url will be displayed (if provided).

Directive

.. changelog::
    :changelog-url: https://your-project.readthedocs.io/en/stable/changelog.html
    :github: https://github.com/you/your-project/releases/
    :pypi: https://pypi.org/project/your-project/

Attributes

  • github (required): URL to the releases page of the repository.
  • changelog-url (optional): URL to the built version of your changelog. sphinx-github-changelog will display a link to your built changelog if the GitHub token is not provided (hopefully, this does not happen in your built documentation)
  • pypi (optional): URL to the PyPI page of the repository. This allows the changelog to display links to each PyPI release.

You’ll notice that each parameter here is not requested in the simplest form but as very specific URLs from which the program extracts the needed information. This is done on purpose. If people browse the unbuilt version of your documentation (e.g. on GitHub or PyPI directly), they’ll still be presented with links to the pages that contain the information they will need, instead of unhelping directives.

Changelog

This documentation itself is “drinking its own champagne”: it uses sphinx-gitHub-changelog. Here’s what it looks like.

1.2.0

Released on 2022-01-21 - GitHub - PyPI

  • Unpin deps (#58)
  • [pre-commit.ci] pre-commit autoupdate (#56)
  • [pre-commit.ci] pre-commit autoupdate (#55)

1.1.0

Released on 2022-01-03 - GitHub - PyPI

Kudos:

@mondeja

1.0.8

Released on 2021-04-17 - GitHub - PyPI

Miscellaneous

Kudos:

@ewjoachim

1.0.7

Released on 2021-04-17 - GitHub - PyPI

Bug Fixes

  • Readthedocs fail on warning (#18)

Kudos:

@ewjoachim

1.0.6

Released on 2021-04-17 - GitHub - PyPI

Miscellaneous

  • Iterate on CI again (#16)
  • ReadTheDocs (#17)

Kudos:

@ewjoachim

1.0.5

Released on 2021-04-17 - GitHub - PyPI

Bug Fixes

  • publish restores the file (#12)

Miscellaneous

  • iterate on CI (#14)
  • Improve cache & publish (#13)
  • pre-commit.ci is now responsible for the linting (#15)

Kudos:

@ewjoachim and @pre-commit-ci[bot]

1.0.4: Add missing dependency dunamai

Released on 2021-04-16 - GitHub - PyPI

Bug Fixes

  • Add dunamai (#11)

Kudos:

@ewjoachim

1.0.3: Redo boilerplate, fix crash when there are draft releases

Released on 2021-04-16 - GitHub - PyPI

Bug Fixes

  • Fixes #8 : node_for_release should not return [] (#9)

Miscellaneous

  • Redo Boilerplate (#10)
  • Adding "Framework :: Sphinx :: Extension" classifier (#7)

Kudos:

@jeriox

1.0.2: Fix for Release Drafts

Released on 2020-07-31 - GitHub - PyPI

Bug Fixes

  • Fix crash in case of draft release (#6)

Misc

  • Check lint in CI (#5)

1.0.1: Travis PyPI deployment

Released on 2020-07-27 - GitHub - PyPI

  • Add PyPI token to Travis (#4)

1.0.0: A fresh start

Released on 2020-07-27 - GitHub - PyPI

Features

  • Initial code (#2)

Bug Fixes

  • Main branch is actually called main (#3)

Test

The following text is just to test the changelog markup

A title