|
1 | | -# Orb Template |
2 | | - |
| 1 | +# Orb |
3 | 2 |
|
4 | 3 | [](https://circleci.com/gh/ExtensionEngine/pipeline-security-orb) [](https://circleci.com/developer/orbs/orb/studion/security) [](https://raw.githubusercontent.com/ExtensionEngine/pipeline-security-orb/master/LICENSE) [](https://discuss.circleci.com/c/ecosystem/orbs) |
5 | 4 |
|
6 | | - |
7 | | - |
8 | | -A project template for Orbs. |
9 | | - |
10 | | -This repository is designed to be automatically ingested and modified by the CircleCI CLI's `orb init` command. |
11 | | - |
12 | | -_**Edit this area to include a custom title and description.**_ |
13 | | - |
14 | | ---- |
15 | | - |
16 | 5 | ## Resources |
17 | 6 |
|
18 | 7 | [CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/studion/security) - The official registry page of this orb for all versions, executors, commands, and jobs described. |
19 | | - |
20 | | -[CircleCI Orb Docs](https://circleci.com/docs/orb-intro/#section=configuration) - Docs for using, creating, and publishing CircleCI Orbs. |
21 | | - |
22 | | -### How to Contribute |
23 | | - |
24 | | -We welcome [issues](https://github.com/ExtensionEngine/pipeline-security-orb/issues) to and [pull requests](https://github.com/ExtensionEngine/pipeline-security-orb/pulls) against this repository! |
25 | | - |
26 | | -### How to Publish An Update |
27 | | -1. Merge pull requests with desired changes to the main branch. |
28 | | - - For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/). |
29 | | -2. Find the current version of the orb. |
30 | | - - You can run `circleci orb info studion/security | grep "Latest"` to see the current version. |
31 | | -3. Create a [new Release](https://github.com/ExtensionEngine/pipeline-security-orb/releases/new) on GitHub. |
32 | | - - Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) tag. (ex: v1.0.0) |
33 | | - - We will have an opportunity to change this before we publish if needed after the next step. |
34 | | -4. Click _"+ Auto-generate release notes"_. |
35 | | - - This will create a summary of all of the merged pull requests since the previous release. |
36 | | - - If you have used _[Conventional Commit Messages](https://conventionalcommits.org/)_ it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published. |
37 | | -5. Now ensure the version tag selected is semantically accurate based on the changes included. |
38 | | -6. Click _"Publish Release"_. |
39 | | - - This will push a new tag and trigger your publishing pipeline on CircleCI. |
0 commit comments