Skip to content

Fix filter pattern cheat sheet examples #1994

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

Merged
merged 3 commits into from
Jan 5, 2021

Conversation

tomjschuster
Copy link
Contributor

@tomjschuster tomjschuster commented Dec 11, 2020

Why:

fixes #855

In the Filter pattern cheat sheet examples section of https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet:

  1. Regex example for matching any number or lowercase letter is shown incorrectly as [0-9a-f] (any hexadecimal number)
  2. Examples of patterns to match different paths are prepended with -, but because they are within table cells, they are shown as literal -'s instead of bullet points. Since many of the patterns actually include -, this is visually confusing.
    dash-bullets

What's being changed:

  1. Correct the regex pattern for numbers/lowercase letters to [0-9a-z]
  2. Remove the - before the pattern examples in the table cells (line breaks should be sufficient for separating the patterns)
    two-linebreaks

Check off the following:

  • All of the tests are passing.
  • I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
  • For content changes, I have reviewed the localization checklist
  • For content changes, I have reviewed the Content style guide for GitHub Docs.

| `'*feature'` | The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | -`mona-feature`<br/>-`feature`<br/>-`ver-10-feature` |
| `v2*` | Matches branch and tag names that start with `v2`. | -`v2`<br/>-`v2.0`<br/>-`v2.9` |
| `v[12].[0-9]+.[0-9]+` | Matches all semantic versioning tags with major version 1 or 2 | -`v1.10.1`<br/>-`v2.0.0` |
| `feature/*` | The `*` wildcard matches any character, but does not match slash (`/`). | `feature/my-branch`<br/><br/>`feature/your-branch` |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding an additional line break to make the separation clearer:
1 line break: 👇
one-linebreak

2 line breaks: 👇
two-linebreaks

@janiceilene
Copy link
Contributor

@tomjschuster Thanks so much for opening a PR! I'll get this triaged for review ⚡

@janiceilene janiceilene added 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 ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team labels Dec 11, 2020
@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 18, 2020
@janiceilene
Copy link
Contributor

Thanks for your patience! Our small team is working our way through reviewing all of the amazing contributions ✨

@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Dec 18, 2020
@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 25, 2020
@tomjschuster
Copy link
Contributor Author

Just commenting to keep this open. Hope everyone is enjoying their holidays.

@github-actions github-actions bot removed the stale There is no recent activity on this issue or pull request label Dec 27, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Jan 3, 2021

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Jan 3, 2021
@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Jan 4, 2021
Copy link
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! Thank you for fixing these issues.

@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label Jan 5, 2021
@skedwards88 skedwards88 merged commit 4629901 into github:main Jan 5, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Jan 5, 2021

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

Vero1979 added a commit to Vero1979/docs that referenced this pull request Jan 5, 2021
* Remove unnecessary word / typo (github#17007)

Fixes https://github.com/github/docs-content/issues/3097

Co-authored-by: Chiedo John <[email protected]>
Co-authored-by: Laura Coursen <[email protected]>

* Update landing pages with recent changelog updates (github#16946)

* add actions changelog items

* update packages changelogs

* Make the repo sync stall check less aggressive (github#17018)

Co-authored-by: chiedo <[email protected]>

* Remove mention of GraphQL API rate limit increases for GHEC organizations (github#17006)

* Section on rate limits should not be nested within section on node limits since those are separate limits

* Remove mention of GraphQL API rate limit increases for GHEC orgs

Fixes https://github.com/github/docs-content/issues/3474

Co-authored-by: Leona B. Campbell <[email protected]>

* reenable graphql updater (github#16994)

* re-enable graphql updater workflow

* remove scheduled run temporarily

* lint yaml

* re-enable graphql updater workflow

* add my pat for test

* use my pat for create pr

* update peter-evans action

* Action ran graphql script"update-files"

* use github-token

* revert

* Action ran graphql script"update-files" (#17000)

* update another workflow

* add schedule run back

Co-authored-by: rachmari <[email protected]>
Co-authored-by: Octomerger Bot <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Add Amazon ECS guide

* Add Azure App Service guide

* Add links to guides

* Fix versioning for "GitHub Insights and data protection for your organization"

* Marketplace should be dotcom-only

* redirect from Enterprise versions of the page

* support hardcoded versions in frontmatter redirects

* Remove duplicated items

* Update content/actions/guides/deploying-to-azure-app-service.md

* Update guidelines-for-legal-requests-of-user-data.md (github#16756)

Remove [email protected] email address from legal request guidelines

Co-authored-by: Melanie Yarbrough <[email protected]>

* change external /contact link to contact variable

* do more path checking

* Revise intro sentence per @imjohnbo's suggestion

* GKE article edits for lists

* Added edits and style changes to Amazon guide

* Added edits and style changes to Azure web app guide

* Replace pseudo environment variables with obvious replaceables in examples

* Fix bad link URL

* fix double slash typo in links

* updates for clarity

* Remove DE language from staging (github#17038)

Co-authored-by: chiedo <[email protected]>

* Remove DataDog from Staging (github#17036)

Remove DataDog from staging

Co-authored-by: chiedo <[email protected]>

* add some clarifying comments

* borrow initial findPage lookup from github#16965

* Code scanning docs: small fixes (github#17035)

* update branch when out of date (github#17031)

* update branch when out of date

* small copy update

* var rename

* lint yaml

* the new map topic handling now needs context.currentPath

* we need to use a regex so we can be sure we are removing the final segment of the path... apparently this is still faster than a split/slice/join

* try to make this check as fast as we can

* Changes to Code Search & what data stays in the index (github#16882)

* Update searching-code.md

* Update searching-code.md

Change only applies to github.com not GHES.

Co-authored-by: Laura Coursen <[email protected]>

* lint

* Update mention in contributing (github#17045)

* add missing redirect frontmatter (github#17042)

Co-authored-by: Sarah Schneider <[email protected]>

* fix repo-sync bug (github#17047)

* fix repo-sync bug

* add another log

* add mergeable_state check

* check for pull number

* add check for prior steps

* remove test logs

* lint

* Fix load site data reporting wrong timing data (github#17050)

* Block indexing not crawling (github#17044)

* Block indexing instead of crawling

* Lint

* Update deprecated-enterprise-versions.js

* Combine loops

* Update content/actions/guides/deploying-to-amazon-elastic-container-service.md

Co-authored-by: Steve Winton <[email protected]>

* Update content/actions/guides/deploying-to-amazon-elastic-container-service.md

Co-authored-by: Steve Winton <[email protected]>

* Update content/actions/guides/deploying-to-amazon-elastic-container-service.md

* Add new patch notes (github#17059)

* Update events-that-trigger-workflows.md (github#17013)

Co-authored-by: skedwards88 <[email protected]>
Co-authored-by: Lucas Costi <[email protected]>

* remove extra lang codes

* replace pageWithSwitcher article with one that does not have a default platform set

* Hide content that overflows in search list (github#17066)

* fix typo in creating-a-pull-request-from-a-fork.md

* Cookie policy updates (github#16554)

Co-authored-by: Peter Cihon <[email protected]>
Co-authored-by: hubwriter <[email protected]>
Co-authored-by: Jenn DeForest <[email protected]>
Co-authored-by: Lucas Costi <[email protected]>

* Edit GHAE version for API header example (github#17056)

* Update docs for generating a new SSH key for windows

I was trying to add a ssh key to my github using windows 10, and i was uncapable to procceed.
And i found that the commands `$ eval $(ssh-agent -s)` don't work on windows, but  ` $ eval `ssh-agent -s` ` works fine

* Add details of the Used by sidebar section (github#17058)

Co-authored-by: Shati Patel <[email protected]>

* npm versions limit (github#17030)

* Add note about this

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Bryan Clark <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryan Clark <[email protected]>

* Update team name (github#17075)

* fix breadcrumbs block

* Clarify container deletion (github#16576)

* Revise deletion steps

* tweak subheader

* Fix all the ways to delete a container image with latest UI

* Delete outdated step

* Confirmed 6 different UI assortments

* small tweak

* ALT text

* Add delete-container-package-version

* Fluidity

* Final edits

* Updating OpenAPI descriptions (github#17076)

* Updating OpenAPI descriptions

* Add decorated OpenAPI schema files

Co-authored-by: Lucas Costi <[email protected]>

* Updating OpenAPI descriptions (github#17077)

* Updating OpenAPI descriptions

* Add decorated OpenAPI schema files

Co-authored-by: Lucas Costi <[email protected]>

* Updating OpenAPI descriptions (github#17079)

* Updating OpenAPI descriptions

* Add decorated OpenAPI schema files

* Fix a few typos (github#16959)

This fixes https://github.com/github/docs-content/issues/2769

Co-authored-by: Chiedo John <[email protected]>
Co-authored-by: Melanie Yarbrough <[email protected]>

* fix typo in Gradle Kotlin DSL script filename extension

* Update resources-in-the-rest-api.md (github#16981)

Co-authored-by: Melanie Yarbrough <[email protected]>

* remove "tests are passing" checkbox

* Change the wording 

I suggest changing the wording of this sentence "The formatting of a field is invalid.  Review the documentation for the for more specific information." so that it would read "The formatting of a field is invalid.  Review the documentation for more specific information".

* Updating OpenAPI descriptions (github#17089)

* Updating OpenAPI descriptions

* Add decorated OpenAPI schema files

* Fix broken links (github#17081)

* Fix two broken links

* Update content/education/manage-coursework-with-github-classroom/leave-feedback-with-pull-requests.md

Co-authored-by: Lucas Costi <[email protected]>

Co-authored-by: Lucas Costi <[email protected]>

* fix typo in Differences between GitHub apps and OAuth apps

* Fix typo in Setting repository visibility

* Hide ToC items with `hidden` (github#17107)

* Update github-subprocessors-and-cookies.md (github#17110)

Remove subprocessor from list

cc: @MayHK

* removed the about-labels masked link.

Reason: Link redirects to the current page, not needed

* Update github-marketplace-developer-agreement.md (github#16710)

Co-authored-by: Melanie Yarbrough <[email protected]>
Co-authored-by: Lucas Costi <[email protected]>

* Added a note about debugging, added intro text.

* Apply suggestions from code review

Co-authored-by: Lucas Costi <[email protected]>

* Minor spelling corrections

* [January 4, 2021] Marketplace revenue change (github#16792)

* Move changes to revenue into new PR

* Minor text changes for revised publication date

* Update content/developers/github-marketplace/receiving-payment-for-app-purchases.md

Co-authored-by: Laura Coursen <[email protected]>

* Clarify revenue change dates

Co-authored-by: Laura Coursen <[email protected]>
Co-authored-by: Melanie Yarbrough <[email protected]>

* Update testing-your-ssh-connection.md (github#2220)

* Update testing-your-ssh-connection.md

The edited language was confusing and incorrect. See https://github.community/t/ssh-fingerprint-matching-issue/150693

* Avoid hardcoded github.com domain in docs link

PR won't pass required tests without this change.

Co-authored-by: hubwriter <[email protected]>

* Add information about management of an enterprise to "About enterprise accounts" article for GitHub AE and GitHub Enterprise Server (github#16818)

* Add links to information about enterprise management

* Address Laura's feedback

* Remove link to page not in GHES/GHAE (github#17122)

* Remove link to page not in GHES/GHAE

* Update content/github/authenticating-to-github/testing-your-ssh-connection.md

Co-authored-by: Shati Patel <[email protected]>

Co-authored-by: Shati Patel <[email protected]>

* Update content/developers/apps/creating-a-github-app-from-a-manifest.md

* Revert broken translated files to english (github#17126)

* Fix invalid syntax for pull_request_target example (github#1890)

Co-authored-by: Sarah Edwards <[email protected]>

* Fix filter pattern cheat sheet examples (github#1994)

* Fix filter pattern cheat sheet examples

* Add additional line break between patterns

Co-authored-by: Sarah Edwards <[email protected]>

* Fix command block rendering with raw tags (#17136)

* Add troubleshooting for HEAD analysis warning (github#17121)

* Dependabot: clarify info about dependency inaccessibility (github#17032)

* Clarify info about dependency inaccessibility

See issue raised by Maya K
https://github.com/github/docs-internal/issues/16786

* Update data/reusables/dependabot/private-dependencies-note.md

Co-authored-by: Maya Kaczorowski <[email protected]>

Co-authored-by: Maya Kaczorowski <[email protected]>

* Make Repo Sync Stall Workflow check for the automated-repo-sync label (github#17142)

Currently the Repo Sync Stall checker is including PRs that aren't repo
sync PRs. This change should ensure that is no longer the case

Co-authored-by: chiedo <[email protected]>
Co-authored-by: Vanessa Yuen <[email protected]>

* Patch (github#17144)

Co-authored-by: chiedo <[email protected]>

* Fix some typos in the lib directory (github#17131)

Co-authored-by: Chiedo John <[email protected]>

* Fix a bunch of random typos (github#17129)

Co-authored-by: Chiedo John <[email protected]>

* Fix a bunch of typos in tests dir (github#17132)

Co-authored-by: Chiedo John <[email protected]>

* Fix a few typos in content dir (github#17133)

Co-authored-by: Chiedo John <[email protected]>

* environments supported on enterprise (github#17127)

* Parentheticals -> parentheses (github#17130)

* Update trade controls FAQ (#17137)

* updates to trade controls

Made updates to the trade controls FAQ to support the 1/5 launch.

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Mike Linksvayer <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Mike Linksvayer <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Mike Linksvayer <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Lynn Hashimoto <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Lynn Hashimoto <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Lynn Hashimoto <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Lynn Hashimoto <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Lynn Hashimoto <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Melanie Yarbrough <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Melanie Yarbrough <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Lynn Hashimoto <[email protected]>

* Update content/github/site-policy/github-and-trade-controls.md

* incorporate overview changes

this commit incorporates the changes made to the overview section. cc @lyhashim for 👀

* Update content/github/site-policy/github-and-trade-controls.md

Co-authored-by: Melanie Yarbrough <[email protected]>

Co-authored-by: Mike Linksvayer <[email protected]>
Co-authored-by: Lynn Hashimoto <[email protected]>
Co-authored-by: Melanie Yarbrough <[email protected]>

* adding link to blog post

* Update github-and-trade-controls.md

* Crowdin translations  (github#17143)

* New Crowdin translations by Github Action

* Revert broken translated files to english

* fix dates

* fix translation 😭

Co-authored-by: Crowdin Bot <[email protected]>

Co-authored-by: Octomerger Bot <[email protected]>
Co-authored-by: Ivan Žužak <[email protected]>
Co-authored-by: Chiedo John <[email protected]>
Co-authored-by: Laura Coursen <[email protected]>
Co-authored-by: Cynthia Rich <[email protected]>
Co-authored-by: chiedo <[email protected]>
Co-authored-by: Leona B. Campbell <[email protected]>
Co-authored-by: jmarlena <[email protected]>
Co-authored-by: Rachael Sewell <[email protected]>
Co-authored-by: rachmari <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Steve Winton <[email protected]>
Co-authored-by: Sarah Schneider <[email protected]>
Co-authored-by: Kevin Heis <[email protected]>
Co-authored-by: Jenn DeForest <[email protected]>
Co-authored-by: Melanie Yarbrough <[email protected]>
Co-authored-by: Lucas Costi <[email protected]>
Co-authored-by: Shati Patel <[email protected]>
Co-authored-by: Sarah Schneider <[email protected]>
Co-authored-by: Rimas Silkaitis <[email protected]>
Co-authored-by: Emily Gould <[email protected]>
Co-authored-by: Steve Winton <[email protected]>
Co-authored-by: Jason Etcovitch <[email protected]>
Co-authored-by: Jaroslav Lobačevski <[email protected]>
Co-authored-by: skedwards88 <[email protected]>
Co-authored-by: lemonez <[email protected]>
Co-authored-by: May Haim Kotlarsky <[email protected]>
Co-authored-by: Peter Cihon <[email protected]>
Co-authored-by: hubwriter <[email protected]>
Co-authored-by: William Torres <[email protected]>
Co-authored-by: Janice <[email protected]>
Co-authored-by: Bryan Clark <[email protected]>
Co-authored-by: Arhell <[email protected]>
Co-authored-by: github-openapi-bot <[email protected]>
Co-authored-by: HonkingGoose <[email protected]>
Co-authored-by: Tammy Metz <[email protected]>
Co-authored-by: Daria <[email protected]>
Co-authored-by: gsonly <[email protected]>
Co-authored-by: Plato <[email protected]>
Co-authored-by: Dhruvin-Purohit <[email protected]>
Co-authored-by: Jae Pak <[email protected]>
Co-authored-by: Martin Lopes <[email protected]>
Co-authored-by: Lucas Alves <[email protected]>
Co-authored-by: Felicity Chapman <[email protected]>
Co-authored-by: Charles Curley <[email protected]>
Co-authored-by: Matt Pollard <[email protected]>
Co-authored-by: Vanessa Yuen <[email protected]>
Co-authored-by: Tom Schuster <[email protected]>
Co-authored-by: Maya Kaczorowski <[email protected]>
Co-authored-by: Kathy Korevec <[email protected]>
Co-authored-by: Mike Linksvayer <[email protected]>
Co-authored-by: Lynn Hashimoto <[email protected]>
Co-authored-by: Samantha Chau <[email protected]>
Co-authored-by: Crowdin Bot <[email protected]>
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 This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team ready to merge This pull request is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix miscellaneous errors in "Filter Pattern" section of GitHub Actions / Reference / Workflow syntax
4 participants