Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add structured changelog #1380

Merged
merged 9 commits into from Mar 24, 2023
Merged

Docs: Add structured changelog #1380

merged 9 commits into from Mar 24, 2023

Conversation

provinzkraut
Copy link
Member

@provinzkraut provinzkraut commented Mar 24, 2023

Ensure a consistent structure and layout of our changelog by introducing two new directives:

  • .. changelog::
  • .. change::

A changelog can be described as

.. changelog:: 2.3.4

  .. change:: This fixes a bug
    :type: bugfix
    :pr: <related pull request>
    :issue: <related issue>

    Here goes the description of the bug fix


  .. change:: This is a new feature
    :type: feature
    :pr: <related pull request>

    Here goes the description of the new feature

Our Sphinx extension will then generate an ordered changelog from these.

Pull Request Checklist

  • New code has 100% test coverage
  • (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
  • (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR

By submitting this issue, you agree to:

Description

Close Issue(s)

@provinzkraut provinzkraut requested a review from a team as a code owner March 24, 2023 15:55
@sonarcloud
Copy link

sonarcloud bot commented Mar 24, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@provinzkraut provinzkraut merged commit 8e1bcfc into main Mar 24, 2023
14 checks passed
@provinzkraut provinzkraut deleted the sphinx-changelog branch March 24, 2023 16:44
Copy link
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants