Skip to content
Merged
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
21 changes: 21 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
..
This is the feedparser-sgmllib changelog.

It is managed and updated by scriv during development.
Do not edit this file directly.
Instead, run "scriv create" to create a new changelog fragment.


CHANGELOG
#########


Unreleased changes
==================

Please see the fragment files in the `changelog.d directory`_.

.. _changelog.d directory: https://github.com/python-syndication/feedparser-sgmllib/tree/main/changelog.d


.. scriv-insert-here

.. _changelog-1.0.0:

1.0.0 - 2026-07-27
==================

Expand Down
4 changes: 4 additions & 0 deletions changelog.d/20260729_122729_kurtmckee_use_scriv.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Development
-----------

* Use scriv to manage the CHANGELOG.
28 changes: 28 additions & 0 deletions changelog.d/fragment-template.rst.jinja2
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
..

Please select the correct category for the change you are making.

1. Remove all lines before and after the chosen category
including these instructions and the divider lines that
use tildes ("~").

2. Remove the four spaces in front of the remaining text.

3. Describe your change using active verbs and full sentences.
For example, write "Support a new feature" instead of
"Supports a new feature" or "A new feature is supported".

4. If your change is associated with an issue on GitHub,
list the issue number(s) in parentheses, separated by
commas. For example:

Support a new feature. (#10, #20)

{% for category in config.categories %}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

{{ category }}
{{ config.rst_header_chars[1] * (category|length) }}

* Describe your "{{ category }}" change here. EDIT ME!
{% endfor -%}
2 changes: 2 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
:tocdepth: 2

.. include:: ../CHANGELOG.rst
25 changes: 25 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,28 @@ filterwarnings = [
"error",
]
strict = true


# scriv
# -----

[tool.scriv]
version = "literal: pyproject.toml: project.version"
categories = [
"Breaking changes",
"Python support",
"Added",
"Fixed",
"Removed",
"Changed",
"Deprecated",
"Security",
"Documentation",
"Development",
]
entry_title_template = "{{ version }} - {{ date.strftime('%Y-%m-%d') }}"
format = "rst"
fragment_directory = "changelog.d"
insert_marker = "scriv-insert-here"
main_branches = ["main", "releases"]
new_fragment_template = "file: fragment-template.rst.jinja2"