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

Cover writing top-level release notes with categories enabled #134

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ fragment, you provide your change information in the appropriate category.
When the fragments are collected, they are grouped by category into a single
changelog entry.

Any fragments that do not specify a category are included as top-level
release notes directly under the release heading.

You can choose not to use categories by setting the :ref:`config_categories`
setting to empty.
setting to empty (all notes will appear as top-level release notes).


.. _entries:
Expand Down
1 change: 1 addition & 0 deletions src/scriv/templates/new_fragment.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
A new scriv changelog fragment.

Uncomment the section that is right (remove the HTML comment wrapper).
For top level release notes, leave all the headers commented out.
-->

{% for cat in config.categories -%}
Expand Down
3 changes: 2 additions & 1 deletion src/scriv/templates/new_fragment.rst.j2
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. A new scriv changelog fragment.
{% if config.categories -%}
..
.. Uncomment the header that is right (remove the leading dots).
.. Uncomment the section that is right (remove the leading dots).
.. For top level release notes, leave all the headers commented out.
..
{% for cat in config.categories -%}
.. {{ cat }}
Expand Down
Loading