GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-101100: Test only Doc/ files in nit-picky mode by hugovk · Pull Request #103019 · python/cpython

Conversation

@hugovk

@hugovk hugovk commented Mar 24, 2023 •
edited by bedevere-bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Follow on from #102513.

To fix #102513 (comment).

The problem is that the https://github.com/Ana06/get-changed-files action gives an error if there's a filename with a space, for example, a news file such as Misc/NEWS.d/next/Core and Builtins/2023-03-17-12-09-45.gh-issue-100982.Pf_BI6.rst.

The error suggests using another format:

Error: One of your files includes a space. Consider using a different output format or removing spaces from your filenames. Please submit an issue on this action's GitHub repo.

We can get in CSV or JSON format instead:

  • https://github.com/Ana06/get-changed-files#get-all-added-and-modified-files-as-csv

But that would require some refactoring, as we need to touch the list of files.

The quick fix is to filter for files in the Doc/ directory, to only consider those:

  • https://github.com/Ana06/get-changed-files#filtering

It would of course be good to check the NEWS files, but it's less urgent than fixing the CI and unblocking other PRs!

Demo

hugovk#45 is a PR that modifies a Doc/ file plus a Misc/NEWS.d/next/Core and Builtins/ file, and the "Docs / Docs" CI check fails, as expected.

hugovk#44 is the same but also has this change, and "Docs / Docs" passes.

  • Issue: Fix all Sphinx reference warnings in the documentation #101100

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@hugovk
pythongh-101100: Filter only Doc/ files
579a37d
@hugovk
hugovk requested a review from ezio-melotti as a code owner March 24, 2023 22:16
@bedevere-bot bedevere-bot mentioned this pull request Mar 24, 2023
Fix all Sphinx reference warnings in the documentation #101100
Closed
@bedevere-bot bedevere-bot added the awaiting core review label Mar 24, 2023
@hugovk hugovk added the skip news label Mar 24, 2023
@hugovk hugovk mentioned this pull request Mar 24, 2023
gh-101100: Test docs in nit-picky mode #102513
Merged
1 task done
AlexWaygood
AlexWaygood approved these changes Mar 25, 2023
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Mar 25, 2023
@AlexWaygood

AlexWaygood commented Mar 25, 2023

Copy link
Copy Markdown
Member

Makes sense as a short-term fix!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

CAM-Gerlach
CAM-Gerlach approved these changes Mar 25, 2023
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM, thanks @hugovk for the quick fix!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@hugovk
hugovk merged commit 87adc63 into python:main Mar 25, 2023
@bedevere-bot bedevere-bot removed the awaiting merge label Mar 25, 2023
@hugovk hugovk mentioned this pull request Mar 25, 2023
GH-93533: Shrink the LOAD_ATTR caches #103014
Closed
@encukou

encukou commented Mar 27, 2023

Copy link
Copy Markdown
Member

We can get in CSV or JSON format instead

IMO, the best fix would be to avoid spaces in CPython sources, so we can use simpler (though less generally correct) tooling.
Here's the blurb issue for it: python/core-workflow#186

hugovk and CAM-Gerlach reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk
hugovk deleted the docs-nit-picky-fix branch March 27, 2023 11:32
Fidget-Spinner pushed a commit to Fidget-Spinner/cpython that referenced this pull request Mar 27, 2023
@hugovk @Fidget-Spinner
pythongh-101100: Test only Doc/ files in nit-picky mode (python#103019)
6f2c3f0
pythongh-101100: Filter only Doc/ files
@hugovk hugovk mentioned this pull request Mar 28, 2023
blurb: replace spaces with underscores in news directory python/core-workflow#499
Merged
warsaw pushed a commit to warsaw/cpython that referenced this pull request Apr 11, 2023
@hugovk @warsaw
pythongh-101100: Test only Doc/ files in nit-picky mode (python#103019)
e61e12f
pythongh-101100: Filter only Doc/ files
This was referenced May 30, 2023
Convert doc.yml workflow to be reusable #103914
Merged
CI: Temporarily skip paths with spaces to avoid error #105110
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes
@AlexWaygood AlexWaygood AlexWaygood approved these changes
@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti ezio-melotti is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@hugovk @AlexWaygood @encukou @CAM-Gerlach @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.