specifications: add build-details.json (PEP 739) #1807
Conversation
FFY00
force-pushed
the
add-pep739
branch
2 times, most recently
from
38f0e12 to
43e7116
Compare
Signed-off-by: Filipe Laíns <lains@riseup.net>
|
@CAM-Gerlach, could you review this? Thanks! |
Co-authored-by: Zanie Blue <contact@zanie.dev>
source/conf.py
Outdated
| @@ -128,6 +129,7 @@ | |||
|
|
|||
| linkcheck_ignore = [ | |||
| "http://localhost:\\d+", | |||
| "https://packaging.python.org/en/latest/specifications/schemas/*", | |||
There was a problem hiding this comment.
Also, shouldn't this be a regex?
There was a problem hiding this comment.
Because the URL doesn't exist yet, so the CI will always fail.
| - :ref:`build-details-v1.0` | ||
|
|
||
| * - Schema | ||
| - https://packaging.python.org/en/latest/specifications/schemas/python-build-info-v1.0.schema.json |
There was a problem hiding this comment.
I'd very strongly prefer to have it show the full canonical URL that can be used as the schema identifier.
There was a problem hiding this comment.
I'm wondering if it'd be possible to migrate to using something like the :download: role.. Any ideas?
There was a problem hiding this comment.
Should we be storing this under _static/ instead?
Additionally, it should be possible to do something like
| - https://packaging.python.org/en/latest/specifications/schemas/python-build-info-v1.0.schema.json | |
| - `https://packaging.python.org/en/latest/_static/schemas/python-build-info-v1.0.schema.json <_static/schemas/python-build-info-v1.0.schema.json>`_ |
This needs testing. But if it works, we'd be able to get rid of the linkignore thing.
There was a problem hiding this comment.
Should we be storing this under
_static/instead?
I don't think having _static in the canonical ID URL looks good. I added the schemas directory to html_extra_path.
Additionally, it should be possible to do something like
This needs testing. But if it works, we'd be able to get rid of the linkignore thing.
I tried using both a normal link like in that snippet, and the download role, neither fixed the link check.
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Signed-off-by: Filipe Laíns <lains@riseup.net>
|
With great power, comes an annoying amount of responsibility. Yield it carefully @FFY00, whom I've added to the packaging.python.org editors list. |
|
@webknjaz can you have a look again, so that we can unblock the PR? |
Signed-off-by: Filipe Laíns <lains@riseup.net>
Signed-off-by: Filipe Laíns <lains@riseup.net>
Signed-off-by: Filipe Laíns <lains@riseup.net>
| @@ -128,6 +133,7 @@ | |||
|
|
|||
| linkcheck_ignore = [ | |||
| "http://localhost:\\d+", | |||
| "https://packaging.python.org/en/latest/specifications/schemas/.*", | |||
| "https://test.pypi.org/project/example-package-YOUR-USERNAME-HERE", | |||
| "https://pypi.org/manage/*", | |||
There was a problem hiding this comment.
I worked out why these trailing globs seem to work: linkcheck_ignore does a prefix match on the given regexes, so finishing with /* (zero-or-more trailing slashes) is essentially identical to omitting that part of the pattern.
To force a whole string match instead of a prefix match you have to specifically terminate the pattern with $
|
Looks good to me too, so I went ahead and marked this one as ready for merging. @webknjaz I think your link cleanup requests are reasonable, but also easier to resolve once we've published a version that includes the schema file. |
| - :ref:`build-details-v1.0` | ||
|
|
||
| * - Schema | ||
| - :download:`https://packaging.python.org/en/latest/specifications/schemas/build-details-v1.0.schema.json <../schemas/build-details-v1.0.schema.json>` |
There was a problem hiding this comment.
Looks like the actual generated href isn't preserved, as :download: copies things into another location.
There was a problem hiding this comment.
You are right, thanks for noticing, we should go back to a normal link then.
| @@ -82,6 +83,10 @@ | |||
| # https://plausible.io/packaging.python.org | |||
| html_js_files.extend(_metrics_js_files) | |||
|
|
|||
| html_extra_path = [ | |||
There was a problem hiding this comment.
Why is this needed? I don't think it works the way you assume...
|
@ncoghlan we can unblock and deal with the consequences later, but this is broken, FWIW. |
github-merge-queue
bot
removed this pull request from the merge queue due to Branch Protection failures
📚 Documentation preview 📚: https://python-packaging-user-guide--1807.org.readthedocs.build/en/1807/