Skip to content

Commit be1c130

Browse files
Updated examples and contributing documentation
* updated examples to include workflow and added contributing docs * fixed links in contributing
1 parent 0496bd3 commit be1c130

File tree

3 files changed

+40
-2
lines changed

3 files changed

+40
-2
lines changed

devel/contributing.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Contributing
2+
3+
To get started, install the CircleCI CLI:
4+
5+
```
6+
brew install circleci
7+
```
8+
9+
Familiarize yourself with the best practices in the [orb authoring process](https://circleci.com/docs/2.0/orb-author/).
10+
11+
Make changes to the orb in the src folder. After you are done updating, pack and validate the orb locally:
12+
13+
```
14+
circleci orb pack > orb.yml
15+
circleci orb validate orb.yml
16+
```
17+
Note: the packed orb.yml file does not need to be committed to the repo. CircleCI will take care of all of this on release.
18+
19+
If you update the pipeline, you can try validating the config or locally executing jobs, but this behavior has been flaky with the dynamic configuration recommended in the orb authoring documentation.
20+
21+
```
22+
circleci config validate
23+
circleci local execute
24+
```
25+
26+
## Creating a New Release
27+
28+
Changes should be made on a new branch. The new branch should be merged to the master branch via a pull request. Ensure that all of the CI pipeline checks and tests have passed for your changes.
29+
30+
After the pull request has been approved and merged to master, follow the Github process for [creating a new release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). This will kick off a new pipeline execution, and the orb will automatically be published to the CircleCI registry if the pipeline finishes successfully. Check the [Matlab orb registry](https://circleci.com/developer/orbs/orb/mathworks/matlab) for the new version after the pipeline finishes executing.

src/examples/run-custom-script.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: >
44
usage:
55
version: 2.1
66
orbs:
7-
matlab: mathworks/matlab@x.y
7+
matlab: mathworks/matlab@0
88
jobs:
99
build:
1010
machine:
@@ -14,3 +14,7 @@ usage:
1414
- matlab/install
1515
- matlab/run-command:
1616
command: myscript
17+
workflows:
18+
build:
19+
jobs:
20+
- build

src/examples/run-tests-with-report.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: >
44
usage:
55
version: 2.1
66
orbs:
7-
matlab: mathworks/matlab@x.y
7+
matlab: mathworks/matlab@0
88
jobs:
99
build:
1010
machine:
@@ -16,3 +16,7 @@ usage:
1616
test-results-junit: test-results/matlab/results.xml
1717
- store_test_results:
1818
path: test-results
19+
workflows:
20+
build:
21+
jobs:
22+
- build

0 commit comments

Comments
 (0)