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 orb pack instructions #496

Merged
merged 3 commits into from
Nov 13, 2024

Conversation

MikeMcC399
Copy link
Collaborator

Issue

The instructions in CONTRIBUTING > Local Packing do not result in the generation of a file orb.yml which is needed for the command circleci orb validate orb.yml.

The CircleCI documentation Orb packing quotes the example command that generates a file:

circleci orb pack <dir> > orb.yml

Change

Correct the instructions in CONTRIBUTING > Local Packing to read:

circleci orb pack ./src > orb.yml

@MikeMcC399 MikeMcC399 added type: bug 🐛 Something isn't working documentation labels Nov 11, 2024
@MikeMcC399 MikeMcC399 self-assigned this Nov 11, 2024
@cypress-app-bot
Copy link
Collaborator

@MikeMcC399 MikeMcC399 marked this pull request as ready for review November 11, 2024 17:21
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

Thanks!

@jennifer-shehane jennifer-shehane merged commit b462146 into cypress-io:master Nov 13, 2024
7 of 8 checks passed
@MikeMcC399 MikeMcC399 deleted the fix/contributing-pack 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