Skip to content

CI: GitHub Actions: Modification condition for JS test directories seems to be too precise. #12444

@jayaddison

Description

@jayaddison

Describe the bug

Sphinx has GitHub Actions workflows configured to run JavaScript-based testing of some of the client-side functionality included when documentation projects are built.

The workflows are configured to run these tests using NodeJS-based GitHub Actions runner hosts when pull_request and push events occur on the repository.

This is mostly working well, but I think that some of the path limits applied to these events - in particular the tests/js file path filter may be too precise:

I think the above filter is intended to mean "any modification within the tests/js directory should invoke JavaScript continuous integration testing on the NodeJS runner". Instead I think it currently technically expresses "any modification to the tests/js directory object itself, but not to its contents, ...".

This is based on noticing that NodeJS continuous integration has not yet run on any of the three commits in #12441. In particular, the fact that NodeJS-CI did not run on the third commit, cb0f6e7, leaves the false impression that the test cases added in that PR are currently passing (they should not be, and do not when I run them locally).

How to Reproduce

  1. Make modifications to tests/js/searchtools.js or other file within the tests/js directory on a local branch.
  2. Push the branch and open a pull request from it on sphinx.git.

Expected:

  • The CI (node.js) job should be among the GitHub Actions workflows run for the latest commit on the opened pull request.

Actual:

  • The CI (node.js) job is not run for the pull request.

Environment Information

N/A

Sphinx extensions

N/A

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    github_actionsPull requests that update GitHub Actions codejavascriptPull requests that update Javascript codetype:bugtype:tests

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions