Skip to content

docs: harmonize examples 'use: ./' syntax explanation#1534

Merged
jennifer-shehane merged 4 commits into
cypress-io:masterfrom
MikeMcC399:docs/run-local-explanation
Sep 3, 2025
Merged

docs: harmonize examples 'use: ./' syntax explanation#1534
jennifer-shehane merged 4 commits into
cypress-io:masterfrom
MikeMcC399:docs/run-local-explanation

Conversation

@MikeMcC399
Copy link
Copy Markdown
Collaborator

Situation

Example workflows, such as .github/workflows/example-basic.yml include the syntax uses: ./ to run the action from the root of the repo's current branch. This is not explained in the README and the comments in the different example workflows in the .github/workflows are inconsistently worded. Some workflows don't contain any related remark.

Change

  • Add an explanation to the README about uses: ./
  • Add a comment to the workflows:
uses: ./ # if copying, replace with cypress-io/github-action@v6

For workflows with multiple calls to the action, add a comment at the top of the workflow to avoid replicating the comment on multiple lines:

# In the example jobs, the action is called with
# uses: ./
# which runs the action code from the current branch.
# If you copy this workflow to another repo, replace the above line with
# uses: cypress-io/github-action@v6

@cypress-app-bot
Copy link
Copy Markdown
Collaborator

@MikeMcC399 MikeMcC399 added the documentation Improvements or additions to documentation label Sep 1, 2025
@MikeMcC399 MikeMcC399 self-assigned this Sep 1, 2025
@MikeMcC399 MikeMcC399 marked this pull request as ready for review September 1, 2025 14:28
Comment thread .github/workflows/example-build-artifacts.yml Outdated
Comment thread .github/workflows/example-chrome.yml Outdated
Comment thread .github/workflows/example-config.yml Outdated
Comment thread .github/workflows/example-custom-ci-build-id.yml Outdated
Comment thread .github/workflows/example-env.yml Outdated
Comment thread .github/workflows/example-recording.yml Outdated
Comment thread .github/workflows/example-start-and-pnpm-workspaces.yml Outdated
Comment thread .github/workflows/example-start-and-yarn-workspaces.yml Outdated
Comment thread .github/workflows/example-start.yml Outdated
Comment thread .github/workflows/example-wait-on.yml Outdated
@MikeMcC399
Copy link
Copy Markdown
Collaborator Author

@jennifer-shehane

I made your suggested style change through a global edit as the debug workflow was the original text I copied from and that wasn't visible in the PR.

@jennifer-shehane jennifer-shehane merged commit b1038d0 into cypress-io:master Sep 3, 2025
78 checks passed
@MikeMcC399 MikeMcC399 deleted the docs/run-local-explanation branch September 3, 2025 12:10
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 6.10.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants