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: fix local execute instructions #497

Merged

Conversation

MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented Nov 12, 2024

Issue

The instructions in the CONTRIBUTING document to execute a job locally do not work. For instance, in the section CircleCI Local Review the following command:

circleci local execute --job orb-tools/review

results in the error message:

Error: unknown flag: --job

The help text is also shown:

┃  circleci local execute                                                                                                ┃
┃                                                                                                                        ┃
┃  Usage:                                                                                                                ┃
┃         circleci local execute <job-name> [flags]

Change

Correct the instructions in the CONTRIBUTING document to remove the --job flag from commands using it. According to the help text, the <job-name> requires no flag to introduce it.

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399 MikeMcC399 added type: bug 🐛 Something isn't working documentation labels Nov 12, 2024
@MikeMcC399 MikeMcC399 self-assigned this Nov 12, 2024
@MikeMcC399 MikeMcC399 marked this pull request as ready for review November 12, 2024 13:57
@jennifer-shehane jennifer-shehane merged commit 267faaa into cypress-io:master Nov 13, 2024
7 of 8 checks passed
@MikeMcC399 MikeMcC399 deleted the fix/contributing-execute branch November 13, 2024 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation type: bug 🐛 Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants