Skip to content

Fix the missing source_url warning raised by jaraco.packaging.sphinx#817

Merged
webknjaz merged 1 commit into
cherrypy:mainfrom
julianz-:fix-source-url
Mar 6, 2026
Merged

Fix the missing source_url warning raised by jaraco.packaging.sphinx#817
webknjaz merged 1 commit into
cherrypy:mainfrom
julianz-:fix-source-url

Conversation

@julianz-

@julianz- julianz- commented Feb 27, 2026

Copy link
Copy Markdown
Member

Version 10.4.0 of jaraco.packaging.sphinx introduced the requirement to provide a Source url. This PR adds it to the urls metadata in pyproject.toml. However, because this addition, in effect, duplicates the GitHub: repo url that appears in the left sidebar of the PyPI project page, the latter is removed.

What kind of change does this PR introduce?

  • 🐞 bug fix
  • 🐣 feature
  • 📋 docs update
  • 📋 tests/coverage improvement
  • 📋 refactoring
  • 💥 other

📋 What is the related issue number (starting with #)

Resolves #

What is the current behavior? (You can also link to an open issue here)
Builds currently fail with a warning:

The config value 'source_url' has type 'NoneType', defaults to 'str'. See e.g. here

The jaraco.packaging.sphinx extension added a requirement to provide a source_url as a change in v10.4.0.

What is the new behavior (if this is a feature change)?

📋 Other information:

📋 Contribution checklist:

(If you're a first-timer, check out
this guide on making great pull requests)

  • I wrote descriptive pull request text above
  • I think the code is well written
  • I wrote good commit messages
  • I have squashed related commits together after
    the changes have been approved
  • Unit tests for the changes exist
  • Integration tests for the changes exist (if applicable)
  • I used the same coding conventions as the rest of the project
  • The new code doesn't generate linter offenses
  • Documentation reflects the changes
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences

@psf-chronographer psf-chronographer Bot added the bot:chronographer:provided A mark meaning that a new change log entry is present within the patch. label Feb 27, 2026
@codecov

codecov Bot commented Feb 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.19%. Comparing base (4bb134f) to head (cf4c896).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #817      +/-   ##
==========================================
- Coverage   78.21%   78.19%   -0.03%     
==========================================
  Files          41       41              
  Lines        4788     4788              
  Branches      547      547              
==========================================
- Hits         3745     3744       -1     
  Misses        905      905              
- Partials      138      139       +1     

@@ -0,0 +1,3 @@
Fixes the missing source_url warning raised by jaraco.packaging.sphinx during docs build.

@webknjaz webknjaz Feb 28, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Change logs should talk about more high-level effects. And we should mostly either use the past tense or present simple (but not in imperative mood). The end-users would expect to see a summary what's changed for them since the previous public release was made (not since the previous commit) — the audience is somewhat different from the Git commit consumers.

I find it useful opening a preview @ https://cheroot--817.org.readthedocs.build/en/817/history/#packaging-updates-and-notes-for-downstreams and seeing if the writing style is the same as the surrounding text.

P.S. Additionally, if you reference some internal/technical identifiers, make sure to use RST syntax to highlight and/or link them. It's a prose for humans, after all.
P.P.S. This doesn't really need to get into the internals of something showing warnings but instead talk about the effect of the change which is that a link to the GitHub repository page will show up on PyPI as it's not exposed via the core packaging metadata.

@julianz- julianz- Feb 28, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks for the reminder about the preview and about the effect on PyPI. Have revised the change log. I also removed the Repo URL as this would be a duplication of the Source URL - so I reworded things slightly taking this into account.

Version 10.4.0 of jaraco.packaging.sphinx introduced the requirement to
provide a source_url. This commit adds the url to pyproject.toml but to avoid
duplication on the PyPI homepage we remove the repo url which was the
same.
@@ -0,0 +1,4 @@
Fixed the source code repository URL not being correctly

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

"correctly" is rather subjective. It's rather "the way jaraco wanted". But fine, it's not a reason to block the PR.

@webknjaz webknjaz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🎉

@webknjaz webknjaz merged commit 0baf7e0 into cherrypy:main Mar 6, 2026
80 of 83 checks passed
@julianz- julianz- deleted the fix-source-url branch March 6, 2026 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided A mark meaning that a new change log entry is present within the patch.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants