`on.<push|pull_request|pull_request_target>.<paths|paths-ignore>` should indicate how to match on git submodules

Open Beginner friendly
#44,228 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start with the workflow syntax article's on.push|pull_request|pull_request_target.paths|paths-ignore section and review the linked PowerDNS comparison for context. Update the article to explain that changes in a git submodule should match the top-level submodule path rather than paths inside it; verify the wording and links render correctly.

Written by the indexing model from the issue text.

Description

content github_actions needs SME never-stale
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onpushpull_requestpull_request_targetpathspaths-ignore

What part(s) of the article would you like to see updated?

Add a note that for changes to files in git submodules, the path to the changed top level submodule should be used (instead of the path to files within the submodule).

Additional information

It took a couple of attempts for a dev to figure out the correct way to make this work: https://github.com/PowerDNS/pdns/compare/56c6b1011d488e26673320b9d54aa4a3bce6a28d..a13665dcb8f9d57033820f53d83aa3e387ca9ecb

Dominant language
TypeScript
Stars
20.9k
Forks
68.8k
Avg merge
15h 4m
Merged PRs (30d)
103

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/docs

All issues in github/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.