Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tests / Docs / Docs fails on old PRs with blurb #106689

Closed
terryjreedy opened this issue Jul 12, 2023 · 3 comments
Closed

Tests / Docs / Docs fails on old PRs with blurb #106689

terryjreedy opened this issue Jul 12, 2023 · 3 comments
Labels
tests Tests in the Lib/test dir

Comments

@terryjreedy
Copy link
Member

The tests for PR #8150 were all green. When I added a blurb for #8150, Tests / Docs / Docs failed because of the 4-digit number.
https://github.com/python/cpython/actions/runs/5534988528/jobs/10100701118?pr=8150

Error: ../build/NEWS:751: ERROR: The GitHub ID '8150' seems too low"

The error occurred during the sphinx html build, but I have no idea where the misinformation is stored or what tracker this properly belongs on.

@terryjreedy terryjreedy added type-bug An unexpected behavior, bug, or error tests Tests in the Lib/test dir docs Documentation in the Doc dir labels Jul 12, 2023
@hugovk
Copy link
Member

hugovk commented Jul 12, 2023

The full message:

Error: ../build/NEWS:751: ERROR: The GitHub ID '8150' seems too low -- use :issue:... for BPO IDs

It doesn't work with PR numbers.

It's expecting either a GitHub issue number, the lowest such began at 32426, from when we transferred issues over from https://bugs.python.org/

Or use the other format to specify a BPO ID.

I think the easiest thing is to create a new issue for the PR, and use that issue number.

@hugovk
Copy link
Member

hugovk commented Jul 12, 2023

And here's where the error message comes from:

def gh_issue_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
issue = utils.unescape(text)
# sanity check: all GitHub issues have ID >= 32426
# even though some of them are also valid BPO IDs
if int(issue) < 32426:
msg = inliner.reporter.error(f'The GitHub ID {text!r} seems too low -- '
'use :issue:`...` for BPO IDs', line=lineno)
prb = inliner.problematic(rawtext, rawtext, msg)
return [prb], [msg]
text = 'gh-' + issue
refnode = nodes.reference(text, text, refuri=GH_ISSUE_URI % issue)
return [refnode], []

@terryjreedy terryjreedy removed type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir labels Jul 12, 2023
@terryjreedy
Copy link
Member Author

terryjreedy commented Jul 12, 2023

Thank you for the solution. There was no bpo issue: in the initial message, Ammar said "(Can be marked with skip issue and skip news as it pertains to the build process)" but I decided that a visible addition possibly used by non-core devs (to run coverage) should be mentioned. I opened #106690.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests Tests in the Lib/test dir
Projects
None yet
Development

No branches or pull requests

3 participants