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

Note on the use of square brackets in GitHub Actions workflows filter patterns #18970

Merged
merged 3 commits into from Aug 22, 2022

Conversation

noritada
Copy link
Contributor

@noritada noritada commented Jul 10, 2022

Why:

Closes #18969

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

This PR adds a following sentence and a code example:

Also, when you use [ and/or ] in a pattern within a flow sequence, the pattern must be enclosed in quotes.

# Valid
- [ master, 'release/v[0-9].[0-9]' ]

# Invalid - creates a parse error
- [ master, release/v[0-9].[0-9] ]

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

When `[` and/or `]` are used in a pattern within a YAML flow sequence, the pattern must be enclosed in quotes.
Example statements in GitHub Actions workflows are as follows:

- Syntax error: `branches: [ master, release/v[0-9].[0-9] ]`
- Valid: `branches: [ master, 'release/v[0-9].[0-9]' ]`
@welcome
Copy link

welcome bot commented Jul 10, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team. label Jul 10, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 10, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/using-workflows/workflow-syntax-for-github-actions.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Collaborator

cmwilson21 commented Jul 11, 2022

@noritada Thanks for opening a PR and linking it to your issue! 💛 I'll get this triaged for review!

@cmwilson21 cmwilson21 added content Problems or updates in the docs content on docs.github.com. actions This issue or pull request should be reviewed by the docs actions team 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 Jul 11, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 18, 2022

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

@github-actions
Copy link
Contributor

github-actions bot commented Jul 25, 2022

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

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2022

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

Copy link

@PIYUSH-MISHRA-00 PIYUSH-MISHRA-00 left a comment

this should do it

Copy link
Contributor

@lucascosti lucascosti left a comment

Thanks for this suggestion, @noritada!

I made some minor edits in 66c8f86. I'll get this merged 🚀

@lucascosti lucascosti merged commit f55237c into github:main Aug 22, 2022
20 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Aug 22, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content Problems or updates in the docs content on docs.github.com. needs SME waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants