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.

Sign up for GitHub

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

Jump to bottom

Document workflow_run behaviour when workflow name contains special characters #12572

Closed
1 task done
starizard opened this issue Dec 2, 2021 · 6 comments · May be fixed by #37022
Closed
1 task done

Document workflow_run behaviour when workflow name contains special characters #12572

starizard opened this issue Dec 2, 2021 · 6 comments · May be fixed by #37022
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Comments

@starizard
Copy link

starizard commented Dec 2, 2021 •
edited
Loading

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_run

What changes are you suggesting?

[possible bug]
workflows triggered by workflow_run do not work if the workflow name contains characters like [ ]

for example:

name: "[foo] parent"
on:
  push:
    branches:
      - "main"
    paths:
      - cloud/**
.
.
.

this parent workflow should trigger the child workflow

name: "[bar] child"
on:
  workflow_run:
    workflows:
      - "[foo] parent"
    branches:
      - main
    types:
      - completed
.
.
.

but it doesn't trigger the child workflow,

removing [foo] from the workflow name makes it work

Additional information

No response
@starizard starizard added the content This issue or pull request belongs to the Docs Content team label Dec 2, 2021
@welcome
Copy link

welcome bot commented Dec 2, 2021

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

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 2, 2021
@ramyaparimi ramyaparimi added waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Dec 2, 2021
@ramyaparimi
Copy link
Contributor

ramyaparimi commented Dec 2, 2021 •
edited
Loading

@starizard
Thanks so much for opening this issue! I'll get this triaged for review ⚡

@ramyaparimi ramyaparimi added the actions This issue or pull request should be reviewed by the docs actions team label Dec 9, 2021
@nikordaris
Copy link

are there any other special characters to avoid? Also, is the solution to just not use those special characters in your workflow names?

@lucascosti
Copy link
Contributor

Hi @starizard, thanks for reporting this. I'm not totally sure if this is a bug or not, so before we update the docs, I've asked the Actions engineering team to clarify. Stay tuned.

@lucascosti
Copy link
Contributor

Hi @starizard, I've checked with the engineering team, and I can confirm that this is a known bug.

As a workaround until this issue is fixed, you can escape the square brackets in the workflow_run workflow and it should work. For example:

on:
  workflow_run:
    workflows: \[foo\] parent

I've tried a few other special characters, and they don't seem to be affected by this bug.

We don't document bugs in our documentation, so I'll close this docs issue.

For anyone else experiencing problems with this, please contact the [GitHub Support Community] or (https://github.community/) GitHub Support 🙂.

aheinzel added a commit to aheinzel/rstudio-server-docker that referenced this issue Sep 12, 2023
@aheinzel
handle special char in workflow_run reference
0d48339 
apparently github actions does not like special character in workflow names when they are referenced - see github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 15, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
878b3f0 
…tly according to github/docs#12572
@tt-rkim tt-rkim mentioned this issue Jun 15, 2024
Merged
3 tasks
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 15, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
7c3d2f5 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 15, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
d744925 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 15, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
9e7d23d 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 15, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
acd154e 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 15, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
9d5cff1 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 15, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
67c14c6 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 17, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
3b53f8b 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 17, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
a226377 
…tly according to github/docs#12572
tt-rkim added a commit to tenstorrent/tt-metal that referenced this issue Jun 17, 2024
@tt-rkim
#9319: Add escape characters to ensure workflow name is parsed correc…
ec403bf 
…tly (#9466)

* #9319: Add escape characters to ensure workflow name is parsed correctly according to github/docs#12572

* #9319: Add back all post-commit tests
@EnricoMi
Copy link

EnricoMi commented Mar 21, 2025 •
edited
Loading

It looks like the values of on.workflow_run.workflows are treated as glob patterns.
https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
https://github.com/orgs/community/discussions/50835
actions/runner#3763
#37022

@EnricoMi EnricoMi mentioned this issue Mar 21, 2025
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation on on.workflow_run.workflows EnricoMi/docs-1
5 participants
@nikordaris @lucascosti @starizard @ramyaparimi @EnricoMi