10000 Merge branch 'master' into tjs/orbs-small-changes · stackbuilders/circleci-docs@e40694e · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit e40694e

Browse files
authored
Merge branch 'master' into tjs/orbs-small-changes
2 parents 063fc03 + 1c6895e commit e40694e

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

jekyll/_cci2/creating-orbs.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -246,15 +246,20 @@ In development orbs, the string label given by the user has the following restri
246246
Examples of valid development orb tags:
247247

248248
* Valid:
249+
```
249250
"dev:mybranch"
250251
"dev:2018_09_01"
251252
"dev:1.2.3-rc1"
252253
"dev:myinitials/mybranch"
253254
"dev:myVERYIMPORTANTbranch"
255+
```
254256

255257
* Invalid
258+
259+
```
256260
"dev: 1" (No spaces allowed)
257261
"1.2.3-rc1" (No leading "dev:")
262+
```
258263

259264
In production orbs you must use the form ```X.Y.Z``` where ```X``` is a "major" version, ```Y``` is a "minor" version, and ```Z``` is a "patch" version. For example, 2.4.0 implies the major version 2, minor version 4, and the patch version of 0.
260265

@@ -303,32 +308,25 @@ For a full list of help commands inside the CLI, visit the [CircleCI CLI help](h
303308

304309
To publish an orb, follow the steps listed below as an org Admin.
305310

306-
1. Claim a namespace (assuming you don't yet have one), e.g.;
307-
311+
1. Claim a namespace (assuming you don't yet have one), for example;
308312
`circleci namespace create sandbox github CircleCI-Public`
309313

310-
2. Create the orb inside your namespace, e.g.:
311-
314+
2. Create the orb inside your namespace, for example:
312315
`circleci orb create sandbox/hello-world`
313316

314317
3. Create the content of your orb in a file. You will generally perform this action in your code editor in a git repo made for your orb. For example, let's assume a file in `/tmp/orb.yml` could be made with a simple orb similar to:
315-
316318
`echo '{version: "2.1", description: "a sample orb"}' > /tmp/orb.yml`
317319

318320
4. Validate that your code is a valid orb using the CLI. For example, using the path above you could use:
319-
320321
`circleci orb validate /tmp/orb.yml`
321322

322-
5. Publish a development version of your orb, e.g.:
323-
323+
5. Publish a development version of your orb, for example:
324324
`circleci orb publish /tmp/orb.yml sandbox/hello-world@dev:first`
325325

326326
6. Once you are ready to push your orb to production, you can publish it manually using ```circleci orb publish``` command or promote it directly from the development version. To increment the new dev version to become 0.0.1, use the following command:
327-
328327
`circleci orb publish promote sandbox/hello-world@dev:first patch`
329328

330329
7. Your orb is now published in an immutable form as a production version and can be used safely in builds. You can view the source of your orb by using:
331-
332330
`circleci orb source sandbox/hello-world@0.0.1`
333331

334332

jekyll/_includes/global-nav.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
<li class="subnav-item"><a href="https://circleci.com/docs/2.0/hello-world/">Hello World</a></li>
3030
<li class="subnav-item"><a href="https://circleci.com/docs/">Documentation</a></li>
3131
<li class="subnav-item"><a href="https://circleci.com/integrations/">Integrations</a></li>
32+
<li class="subnav-item" ><a href="https://circleci.com/orbs/">Orbs</a></li>
3233
<li class="subnav-item"><a href="https://circleci.com/docs/api/v1-reference/">API</a></li>
3334
</ul>
3435
</div>
@@ -91,6 +92,7 @@
9192
<li class="subnav-item"><a href="https://circleci.com/docs/2.0/hello-world/">Getting Started</a></li>
9293
<li class="subnav-item"><a href="https://circleci.com/docs/">Documentation</a></li>
9394
<li class="subnav-item"><a href="https://circleci.com/integrations/">Integrations</a></li>
95+
<li class="subnav-item" ><a href="https://circleci.com/orbs/">Orbs</a></li>
9496
<li class="subnav-item"><a href="https://circleci.com/docs/api/v1-reference/">API</a></li>
9597
</ul>
9698
</li>
@@ -116,4 +118,4 @@
116118
</div>
117119
</div>
118120
</div>
119-
</nav>
121+
</nav>
539 KB
Loading

0 commit comments

Comments
 (0)
0