From 5916fcf061801560f004ec63c139216c3d1d7d46 Mon Sep 17 00:00:00 2001 From: David Buzinski Date: Fri, 15 Apr 2022 09:39:59 -0400 Subject: [PATCH 1/2] updated examples to include workflow and added contributing docs --- devel/contributing.md | 30 ++++++++++++++++++++++++++ src/examples/run-custom-script.yml | 6 +++++- src/examples/run-tests-with-report.yml | 6 +++++- 3 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 devel/contributing.md diff --git a/devel/contributing.md b/devel/contributing.md new file mode 100644 index 0000000..9021265 --- /dev/null +++ b/devel/contributing.md @@ -0,0 +1,30 @@ +## Contributing + +To get started, install the CircleCI CLI: + +``` +brew install circleci +``` + +Familiarize yourself with the best practices in the [orb authoring process](URL 'https://circleci.com/docs/2.0/orb-author/'). + +Make changes to the orb in the src folder. After you are done updating, pack and validate the orb locally: + +``` +circleci orb pack > orb.yml +circleci orb validate orb.yml +``` +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. + +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. + +``` +circleci config validate +circleci local execute +``` + +## Creating a New Release + +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. + +After the pull request has been approved and merged to master, follow the Github process for [creating a new release](URL '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](URL 'https://circleci.com/developer/orbs/orb/mathworks/matlab') for the new version after the pipeline finishes executing. diff --git a/src/examples/run-custom-script.yml b/src/examples/run-custom-script.yml index ce5b7da..21dae32 100644 --- a/src/examples/run-custom-script.yml +++ b/src/examples/run-custom-script.yml @@ -4,7 +4,7 @@ description: > usage: version: 2.1 orbs: - matlab: mathworks/matlab@x.y + matlab: mathworks/matlab@0 jobs: build: machine: @@ -14,3 +14,7 @@ usage: - matlab/install - matlab/run-command: command: myscript + workflows: + build: + jobs: + - build diff --git a/src/examples/run-tests-with-report.yml b/src/examples/run-tests-with-report.yml index 84003c7..7719eba 100644 --- a/src/examples/run-tests-with-report.yml +++ b/src/examples/run-tests-with-report.yml @@ -4,7 +4,7 @@ description: > usage: version: 2.1 orbs: - matlab: mathworks/matlab@x.y + matlab: mathworks/matlab@0 jobs: build: machine: @@ -16,3 +16,7 @@ usage: test-results-junit: test-results/matlab/results.xml - store_test_results: path: test-results + workflows: + build: + jobs: + - build From 9970cc3c7be87d8dd0110f98cccb22ff21faa889 Mon Sep 17 00:00:00 2001 From: David Buzinski <103441853+davidbuzinski@users.noreply.github.com> Date: Fri, 15 Apr 2022 06:43:38 -0700 Subject: [PATCH 2/2] fixed links in contributing --- devel/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/devel/contributing.md b/devel/contributing.md index 9021265..fca366e 100644 --- a/devel/contributing.md +++ b/devel/contributing.md @@ -6,7 +6,7 @@ To get started, install the CircleCI CLI: brew install circleci ``` -Familiarize yourself with the best practices in the [orb authoring process](URL 'https://circleci.com/docs/2.0/orb-author/'). +Familiarize yourself with the best practices in the [orb authoring process](https://circleci.com/docs/2.0/orb-author/). Make changes to the orb in the src folder. After you are done updating, pack and validate the orb locally: @@ -27,4 +27,4 @@ circleci local execute 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. -After the pull request has been approved and merged to master, follow the Github process for [creating a new release](URL '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](URL 'https://circleci.com/developer/orbs/orb/mathworks/matlab') for the new version after the pipeline finishes executing. +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.