From c53dddf0f4911016cb27932a4cf8a82802e67c12 Mon Sep 17 00:00:00 2001 From: James Addison Date: Fri, 1 Aug 2025 14:24:32 +0100 Subject: [PATCH 1/6] Link to genuine pull requests from README examples The migration to towncrier in #2203 included a couple of synthetic change note examples. Now that towncrier is in use and some changes that use it have landed in pip-tools, we can update the examples so that they hyperlink to genuine pull requests. This is intended to aid contributors by providing them with more accurate, representative examples to crib from. --- changelog.d/README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/changelog.d/README.md b/changelog.d/README.md index f9d9fb89d..67b0100b0 100644 --- a/changelog.d/README.md +++ b/changelog.d/README.md @@ -62,18 +62,10 @@ Do your best and a maintainer can discuss this with you during review. ### Examples -Example bugfix, `2082.bugfix.md`: +Example contributor update, [`2214.contrib.md`](https://github.com/jazzband/pip-tools/pull/2214): ```md -Fixed the ordering of format controls to preserve underlying `pip` behavior --- by {user}`sethmlarson`. -``` - -Example contributor update, `2202.contrib.md`: - -```md -`pip-tools` now uses [`sphinx-issues`](https://github.com/sloria/sphinx-issues) -to link to issues, PRs, commits, and user accounts +`pip-tools` now tests on and officially supports `pip` version 25.2 . -- by {user}`sirosen`. ``` From 718905e9cd2c1cfd6f01df583b2040cd3a4c2612 Mon Sep 17 00:00:00 2001 From: James Addison Date: Wed, 13 Aug 2025 16:33:51 +0100 Subject: [PATCH 2/6] Restore the minimum of two examples, by adding recent bugfix PR #2224 Relates-to commit 36f7d7e42b9efd018bfa43e73e8ac28052d2a084. --- changelog.d/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/changelog.d/README.md b/changelog.d/README.md index 67b0100b0..5df3017be 100644 --- a/changelog.d/README.md +++ b/changelog.d/README.md @@ -62,6 +62,13 @@ Do your best and a maintainer can discuss this with you during review. ### Examples +Example bugfix, [`2223.bugfix.md`](https://github.com/jazzband/pip-tools/pull/2224): + +```md +Fixed a bug which removed slashes from URLs in ``-r`` and ``-c`` in the output +of ``pip-compile`` -- by {user}`sirosen`. +``` + Example contributor update, [`2214.contrib.md`](https://github.com/jazzband/pip-tools/pull/2214): ```md From ec9ec94626f843a4c36722e3b844a5ab462e7629 Mon Sep 17 00:00:00 2001 From: James Addison Date: Fri, 26 Sep 2025 11:05:37 +0100 Subject: [PATCH 3/6] Refresh attribution note from contrib #2214 --- changelog.d/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/changelog.d/README.md b/changelog.d/README.md index 5df3017be..e167ec9a1 100644 --- a/changelog.d/README.md +++ b/changelog.d/README.md @@ -72,8 +72,7 @@ of ``pip-compile`` -- by {user}`sirosen`. Example contributor update, [`2214.contrib.md`](https://github.com/jazzband/pip-tools/pull/2214): ```md -`pip-tools` now tests on and officially supports `pip` version 25.2 . --- by {user}`sirosen`. +`pip-tools` now tests on and officially supports `pip` version 25.2 -- by :user:`sirosen`. ``` ### Rationale From 1a8cbcc7f1e7a8f041b6eb80cc30ae060af28590 Mon Sep 17 00:00:00 2001 From: James Addison Date: Fri, 26 Sep 2025 11:07:07 +0100 Subject: [PATCH 4/6] docs: update `sphinx` to v7.2.6 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 280ea3c86..7ddab82f6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -72,7 +72,7 @@ snowballstemmer==2.2.0 # via sphinx soupsieve==2.4.1 # via beautifulsoup4 -sphinx==7.2.2 +sphinx==7.2.6 # via # -r docs/requirements.in # furo From 5fcdaf287f48ea05cf9437afa5a623b8bede8351 Mon Sep 17 00:00:00 2001 From: James Addison Date: Fri, 26 Sep 2025 11:12:04 +0100 Subject: [PATCH 5/6] docs: update `sphinxcontrib-serializinghtml` to v1.1.10 Relates-to commit 1a8cbcc7f1e7a8f041b6eb80cc30ae060af28590. Closes #2240 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 7ddab82f6..f9be8c2d4 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -105,7 +105,7 @@ sphinxcontrib-programoutput==0.17 # via -r docs/requirements.in sphinxcontrib-qthelp==1.0.6 # via sphinx -sphinxcontrib-serializinghtml==1.1.8 +sphinxcontrib-serializinghtml==1.1.10 # via sphinx sphinxcontrib-towncrier==0.5.0a0 # via -r docs/requirements.in From e7e2673b289dd0b900b1d6d882e59adab55f4385 Mon Sep 17 00:00:00 2001 From: James Addison Date: Fri, 26 Sep 2025 11:08:08 +0100 Subject: [PATCH 6/6] docs: fixup: update a few `user` attribution directives Closes #2241 --- changelog.d/2214.contrib.md | 2 +- changelog.d/2235.bugfix.md | 2 +- changelog.d/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/changelog.d/2214.contrib.md b/changelog.d/2214.contrib.md index 1052fddd2..c520e8580 100644 --- a/changelog.d/2214.contrib.md +++ b/changelog.d/2214.contrib.md @@ -1 +1 @@ -`pip-tools` now tests on and officially supports `pip` version 25.2 -- by :user:`sirosen`. +`pip-tools` now tests on and officially supports `pip` version 25.2 -- by {user}`sirosen`. diff --git a/changelog.d/2235.bugfix.md b/changelog.d/2235.bugfix.md index 310cc2cbe..5d55a399d 100644 --- a/changelog.d/2235.bugfix.md +++ b/changelog.d/2235.bugfix.md @@ -1,2 +1,2 @@ Fix an incompatibility with ``click >= 8.3`` which made ``pip-compile`` display incorrect -options in the compile command in output headers -- by :user:`sirosen`. +options in the compile command in output headers -- by {user}`sirosen`. diff --git a/changelog.d/README.md b/changelog.d/README.md index e167ec9a1..dcb05e308 100644 --- a/changelog.d/README.md +++ b/changelog.d/README.md @@ -72,7 +72,7 @@ of ``pip-compile`` -- by {user}`sirosen`. Example contributor update, [`2214.contrib.md`](https://github.com/jazzband/pip-tools/pull/2214): ```md -`pip-tools` now tests on and officially supports `pip` version 25.2 -- by :user:`sirosen`. +`pip-tools` now tests on and officially supports `pip` version 25.2 -- by {user}`sirosen`. ``` ### Rationale