Skip to content

Conversation

jayaddison
Copy link
Contributor

@jayaddison jayaddison commented Aug 1, 2025

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 are soon to land 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.

No changelog needed.

Contributor checklist
  • Included tests for the changes.
  • A change note is created in changelog.d/ (see changelog.d/README.md for instructions) or the PR text says "no changelog needed".
Maintainer checklist
  • If no changelog is needed, apply the skip-changelog label.
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).
Additional fixes

Two problems encountered while testing this are currently resolved by this branch:

@jayaddison jayaddison marked this pull request as draft August 1, 2025 13:36
@webknjaz webknjaz requested a review from sirosen August 4, 2025 09:43
@jayaddison jayaddison marked this pull request as ready for review August 13, 2025 15:36
@webknjaz
Copy link
Member

@jayaddison could you rebase instead of pushing merge commits into the topic branch?

@jayaddison
Copy link
Contributor Author

@jayaddison could you rebase instead of pushing merge commits into the topic branch?

Will do on next push; thanks 👍

The migration to towncrier in jazzband#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.
@jayaddison jayaddison force-pushed the pr-2203-followup/reify-changenote-examples branch from 924199c to e7e2673 Compare September 26, 2025 10:13
@jayaddison jayaddison requested a review from webknjaz September 26, 2025 13:49
@sirosen sirosen added this to the 7.5.1 milestone Sep 26, 2025
@sirosen sirosen added the skip-changelog Avoid listing in changelog label Sep 26, 2025
Copy link
Member

@sirosen sirosen left a comment

Choose a reason for hiding this comment

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

This looks good to me; and 👍 for the fixes to the wrong syntax in those fragments.

I don't have a strong feeling that this tweak is going to help contributors a lot, but it's definitely not going to hurt!

@sirosen sirosen added this pull request to the merge queue Sep 26, 2025
Merged via the queue into jazzband:main with commit 76bdc77 Sep 26, 2025
43 checks passed
@jayaddison
Copy link
Contributor Author

Thanks again @sirosen!

@jayaddison jayaddison deleted the pr-2203-followup/reify-changenote-examples branch September 26, 2025 15:20
jayaddison added a commit to openculinary/pip-tools that referenced this pull request Sep 26, 2025
@jayaddison jayaddison mentioned this pull request Sep 26, 2025
4 tasks
github-merge-queue bot pushed a commit that referenced this pull request Sep 26, 2025
soupsieve==2.4.1
# via beautifulsoup4
sphinx==7.2.2
sphinx==7.2.6
Copy link
Member

Choose a reason for hiding this comment

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

This should've been bumped separately. There's no evidence of Sphinx breaking in CI/RTD: https://app.readthedocs.org/projects/pip-tools/builds/. And it's unrelated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fixup: syntax for a couple of user attribution clauses in changelog.d Documentation: build failure with Sphinx 7.2.2

3 participants