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

docs(gh action): use correct workflow yaml syntax #5523

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

schlich
Copy link
Contributor

@schlich schlich commented Oct 6, 2023

Even though this is a stub, it should have the correct syntax with the dash indicating the mapping for "uses"

Even though this is a stub, it should have the correct syntax with the dash indicating the mapping for "uses"
@netlify
Copy link

netlify bot commented Oct 6, 2023

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 419a229

@CLAassistant
Copy link

CLAassistant commented Oct 6, 2023

CLA assistant check
All committers have signed the CLA.

@cypress-app-bot
Copy link
Collaborator

@netlify
Copy link

netlify bot commented Oct 6, 2023

Deploy Preview for benevolent-cat-040f48 ready!

Name Link
🔨 Latest commit 419a229
🔍 Latest deploy log https://app.netlify.com/sites/benevolent-cat-040f48/deploys/651ffc3fc56de300084d4af5
😎 Deploy Preview https://deploy-preview-5523--benevolent-cat-040f48.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@MikeMcC399
Copy link
Contributor

@schlich

According to https://www.yamllint.com/ it is valid YAML:

image

That is only because there is only one uses in the stub. If you wanted to add another step, then you would need the dash. For example, the following is valid:

jobs:
  cypress-run:
    steps:
      - uses: actions/checkout@v4
      - uses: cypress-io/github-action@v6

whereas this is not

# invalid example: don't copy!
jobs:
  cypress-run:
    steps:
      - uses: actions/checkout@v4
        uses: cypress-io/github-action@v6
# leads to "Map keys must be unique" error    

So, even though the original example is valid YAML, I support making your suggested change, which would make the example more general.

@schlich
Copy link
Contributor Author

schlich commented Oct 6, 2023

Huh, TIL. Thanks for the feedback!

@MikeMcC399
Copy link
Contributor

@schlich

Huh, TIL. Thanks for the feedback!

Actually TIL for me too, but only after I researched the topic. 🙂

@mschile mschile merged commit ac60f3e into cypress-io:main Oct 12, 2023
5 checks passed
@mschile
Copy link
Contributor

mschile commented Oct 12, 2023

Hi @schlich 👋, thanks for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants