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.

Sign up for GitHub

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

Jump to bottom

docs: fix CONTRIBUTING typos #499

Merged
merged 1 commit into from
Nov 13, 2024
Merged

docs: fix CONTRIBUTING typos #499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# orb.yml is "packed" from source, and not published directly from the repositor
# orb.yml is "packed" from source, and not published directly from the repository
orb.yml
.DS_Store

node_modules
node_modules
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The repo provides a subset of the _orb-tools_ jobs and scripts that can be run l

### Local Packing

All CircleCI orbs are single YAML files, typically named `orb.yml`. However, for development, it is often easier to break the code up into more manageable chunks. The `circleci orb pack` command, a component of the [orb development kit](https://circleci.com/docs/orb-development-kit/), is used to "pack" or condense the seprate YAML files together into a single `orb.yml` file.
All CircleCI orbs are single YAML files, typically named `orb.yml`. However, for development, it is often easier to break the code up into more manageable chunks. The `circleci orb pack` command, a component of the [orb development kit](https://circleci.com/docs/orb-development-kit/), is used to "pack" or condense the separate YAML files together into a single `orb.yml` file.

```bash
circleci orb pack ./src > orb.yml
```

### Local Validating

Once the `orb.yml` file has been generate via _packing_ you can now validate the configuration using the CircleCI CLI.
Once the `orb.yml` file has been generated via _packing_ you can now validate the configuration using the CircleCI CLI.

```bash
circleci orb validate orb.yml
Expand Down Expand Up @@ -82,7 +82,7 @@ fix: a patch release
### Releasing

1. Merge changes into `master` and validate the CI passes all the necessary steps.
2. Create a Github tag of the last commit which merged to `master` and passed in CI:
2. Create a GitHub tag of the last commit which merged to `master` and passed in CI:
```shell
git checkout master
git pull origin master
Expand Down