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

ci: Testing: make a trivial documentation-related edit #1

Closed

Conversation

jayaddison
Copy link
Member

Currently, the following behaviours are configured for GitHub Actions pull request checks in this repository:

  • Documentation-related commits (Markdown files, CODEOWNERS, the pull request template, and .editorconfig files) in pull requests succeed.
  • Non-documetation-related commits in pull requests fail.

These are configured using the GitHub Actions paths and paths-ignore feature.

Each documentation-related job (e.g. Check perl) has a duplicate non-documentation job with exactly the same name.

This implements a GitHub Actions required-statuses workaround described at: https://github.com/orgs/community/discussions/49124#discussioncomment-5209069

The purpose of this pull request is to find out whether that workaround remains valid. If so, it may provide a simpler solution than using a custom/third-party GitHub Actions action.

Questions:

  • What happens when a pull request contains both documentation and non-documentation modifications?
  • If we were to use this mechanism, is there a way that we could ensure that the inverted and non-inverted path configurations stay in-sync?

@jayaddison jayaddison marked this pull request as ready for review March 20, 2025 16:41
@jayaddison
Copy link
Member Author

What happens when a pull request contains both documentation and non-documentation modifications?

Commit 88c3010 examines this, by merging both this documentation-related pull request (#1) and a corresponding NON-documentation-related pull request (#2).

The answer is that checks related to both workflows (pull_request.yml and pull_request_inverted.yml) are run. For each GitHub Actions required status check, success from one out of the two checks is insufficient to allow merge of the pull request. This seems to indicate that both must succeed.

@jayaddison
Copy link
Member Author

If we were to use this mechanism, is there a way that we could ensure that the inverted and non-inverted path configurations stay in-sync?

What happens when a pull request contains both documentation and non-documentation modifications?

The answer is that checks related to both workflows (pull_request.yml and pull_request_inverted.yml) are run. For each GitHub Actions required status check, success from one out of the two checks is insufficient to allow merge of the pull request. This seems to indicate that both must succeed.

In combination, does this mean that the inverted workflow could have a paths: * wildcard? Meaning that it would always succeed -- fulfilling the GitHub Actions required status check for PRs that do not modify specific filesets -- but also ensuring that if those specific fileset checks do fail, the relevant PRs are still blocked from merge?

@jayaddison jayaddison closed this Mar 22, 2025
@jayaddison jayaddison deleted the gha-ci-adjustment-testing/path-filtering-checks branch March 22, 2025 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant