Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[CI] Skip tests on doc-only changes#25261

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
jklymak merged 1 commit intomatplotlib:mainfromgreglucas:doc-skip
Feb 20, 2023

Conversation

greglucas
Copy link
Contributor

PR Summary

We don't need to waste CI cycles for doc-only changes and having to remember to add[doc skip] to commit messages is asking a lot of users. Also removed extra CI conditionals for skipping that are already handled by GitHub:https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs
(except [skip github], but that isn't documented and it should really be [skip actions], so let's just remove all of them).

I tested this on an example PR on my fork to verify:greglucas#21

I only added this topull_request:, we could also add this topush:, but it seems fine to run tests on every push tomain regardless.

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (andpytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
  • API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
  • Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

rcomer reacted with thumbs up emoji
!contains(github.event.head_commit.message, '[ci skip]') &&
!contains(github.event.head_commit.message, '[skip ci]') &&
!contains(github.event.head_commit.message, '[skip github]') &&
!contains(github.event.head_commit.message, '[ci doc]')
Copy link
Member

@rcomerrcomerFeb 19, 2023
edited
Loading

Choose a reason for hiding this comment

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

[ci doc] should still be useful if you make a docstring only change.[skip github] is specific to these tests, whereas GitHub’s[skip actions] will skip all the GitHub actions. I don’t know whether that difference is important enough to keep[skip github] (we don’t actually advertise it in thedev guide).

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Good point. I guess my thought is that anytime I have to explicitly opt-out of running CI by putting in a commit message I probably won't do that, so in general I was just trying to clean up the file a bit. But, we can leave these in too since they don't hurt anything.

@rcomer
Copy link
Member

Presumably tests will still run if you edit e.g. both an example and some mpl functionality? That doesn’t seem obvious from the GitHub docs.

@greglucas
Copy link
ContributorAuthor

Presumably tests will still run if you edit e.g. both an example and some mpl functionality? That doesn’t seem obvious from the GitHub docs.

Yes, it should cover that case, with an example here:

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-excluding-paths

When all the path names match patterns in paths-ignore, the workflow will not run. If any path names do not match patterns in paths-ignore, even if some path names match the patterns, the workflow will run.

rcomer reacted with thumbs up emoji

# No need to test on documentation changes
- 'doc/**'
- 'examples/**'
- 'tutorials/**'
Copy link
Member

Choose a reason for hiding this comment

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

Need to add plot_types. Note if we get#25209 in we can just test on "galleries/**"

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

👍 We can add more later no problem. I guess an alternative question for the future is whether we really want these at the top-level of the repository versus living underdoc/galleries,doc/plot_types etc... which would then allow justdoc/** to be ignored.

Copy link
Member

Choose a reason for hiding this comment

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

We don't want to do that because then sphinx will try and process them and it will be confusing what the source and result of sphinx-gallery processing them is. However, getting them under one subdirectory at the top level is the goal of#25209

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Ahh, I see. I have not been following the docs reorganization. That does seem like a nice change!

@jklymakjklymak added the CI: testingCI configuration and testing labelFeb 20, 2023
@jklymak
Copy link
Member

I'll merge since there is no point in running CI on a CI change...

@jklymakjklymak merged commitad55758 intomatplotlib:mainFeb 20, 2023
@greglucasgreglucas deleted the doc-skip branchFebruary 20, 2023 16:53
@QuLogicQuLogic added this to thev3.8.0 milestoneFeb 21, 2023
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@jklymakjklymakjklymak approved these changes

@rcomerrcomerrcomer approved these changes

Assignees
No one assigned
Labels
CI: testingCI configuration and testing
Projects
None yet
Milestone
v3.8.0
Development

Successfully merging this pull request may close these issues.

4 participants
@greglucas@rcomer@jklymak@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp