You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 8, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: jekyll/_cci2/creating-orbs.md
+8-10Lines changed: 8 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -246,15 +246,20 @@ In development orbs, the string label given by the user has the following restri
246
246
Examples of valid development orb tags:
247
247
248
248
* Valid:
249
+
```
249
250
"dev:mybranch"
250
251
"dev:2018_09_01"
251
252
"dev:1.2.3-rc1"
252
253
"dev:myinitials/mybranch"
253
254
"dev:myVERYIMPORTANTbranch"
255
+
```
254
256
255
257
* Invalid
258
+
259
+
```
256
260
"dev: 1" (No spaces allowed)
257
261
"1.2.3-rc1" (No leading "dev:")
262
+
```
258
263
259
264
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.
260
265
@@ -303,32 +308,25 @@ For a full list of help commands inside the CLI, visit the [CircleCI CLI help](h
303
308
304
309
To publish an orb, follow the steps listed below as an org Admin.
305
310
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;
2. Create the orb inside your namespace, for example:
312
315
`circleci orb create sandbox/hello-world`
313
316
314
317
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
-
316
318
`echo '{version: "2.1", description: "a sample orb"}' > /tmp/orb.yml`
317
319
318
320
4. Validate that your code is a valid orb using the CLI. For example, using the path above you could use:
319
-
320
321
`circleci orb validate /tmp/orb.yml`
321
322
322
-
5. Publish a development version of your orb, e.g.:
323
-
323
+
5. Publish a development version of your orb, for example:
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:
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:
0 commit comments