docs icon indicating copy to clipboard operation
docs copied to clipboard

Add documentation on `on.workflow_run.workflows`

Open EnricoMi opened this issue 8 months ago β€’ 14 comments

Why:

The values of on.workflow_run.workflows are treated as glob patterns. Special characters requires escaping.

Details: https://github.com/orgs/community/discussions/50835 https://github.com/actions/runner/issues/3763

Closes: #12572

What's being changed (if available, include any code snippets, screenshots, or gifs):

Adds documentation for on.workflow_run.workflows, especially around glob patterns.

Check off the following:

  • [ ] A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • [ ] The changes in this PR meet the docs fundamentals that are required for all content.
  • [ ] All CI checks are passing and the changes look good in the review environment.

EnricoMi avatar Mar 21 '25 09:03 EnricoMi

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Mar 21 '25 09:03 welcome[bot]

How to review these changes πŸ‘“

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

⚠️ Warning: Our review server is experiencing latency issues.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on the review server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/writing-workflows/workflow-syntax-for-github-actions.md fpt
ghec
ghes@ 3.16 3.15 3.14 3.13 3.12
fpt
ghec
ghes@ 3.16 3.15 3.14 3.13 3.12

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

πŸ€– This comment is automatically generated.

github-actions[bot] avatar Mar 21 '25 09:03 github-actions[bot]

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Mar 21 '25 17:03 github-actions[bot]

Thanks so much for opening a PR! I'll get this triaged for review.

Sharra-writes avatar Mar 21 '25 17:03 Sharra-writes

Hi, @EnricoMi. πŸ‘‹ One of the team wanted to make sure you had seen this while we're waiting for feedback from our SMEs on this issue.

Sharra-writes avatar Mar 24 '25 16:03 Sharra-writes

@Sharra-writes thanks for the reply! Please let the team know that I do not see the connection between the Dockerfile WORKDIR option and how Github Actions evaluates values for on.workflow_run.workflow.

EnricoMi avatar Mar 25 '25 15:03 EnricoMi

@EnricoMi Well, no wonder it doesn't seem relevant, because I got my tabs mixed up and put this on the wrong pull request. πŸ˜… I'm so sorry, and thank you for being patient with us. I do have this open for the SMEs to look at.

Sharra-writes avatar Mar 26 '25 17:03 Sharra-writes

Hi @EnricoMi, thanks for raising thisβ€”I'm going to reopen the original issue so we can transfer it internally.

We'll schedule this work as soon as we can. Just so you're aware, there's a few moving parts to this and I can't guarantee that we'll use this PR: since we need to make some further changes, it may be easier for us to start a new one instead. If we do that, would you like us to add you as a co-committer? I notice you're not using noreply on your email address in your commits.

Many thanks

subatoi avatar Mar 27 '25 15:03 subatoi

would you like us to add you as a co-committer

yes, please

EnricoMi avatar Mar 28 '25 22:03 EnricoMi

EnricoMi:workflow_run-workflows

Andzhela78 avatar Apr 04 '25 04:04 Andzhela78

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Jun 06 '25 16:06 github-actions[bot]

This is a gentle bump for the docs team that this PR is waiting for technical review.

github-actions[bot] avatar Jul 05 '25 16:07 github-actions[bot]

This is a gentle reminder for the docs team that this PR is waiting for technical review by a subject matter expert.

github-actions[bot] avatar Sep 03 '25 16:09 github-actions[bot]

Hi team any updates or requirement required to close this ticket