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
Copy file name to clipboardExpand all lines: archived/_cci2/orb-author-intro.adoc
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,14 @@ contentTags:
11
11
:page-layout: classic-docs
12
12
:page-liquid:
13
13
14
-
[#quick-start]
15
-
== Quick start
14
+
CircleCI orbs are packages of xref:orb-concepts#orb-configuration-elements[reusable configuration] that you can import into you CircleCI configuration files. Orbs come in two types:
16
15
17
-
Orbs take xref:orb-concepts#orb-configuration-elements[reusable configuration] and package it in a way that can be published to the link:https://circleci.com/developer/orbs[Orb Registry] and imported into multiple configuration files. If you manage multiple, similar projects, consider abstracting out your config with orbs.
16
+
* Registry orbs are packaged in a way that can be published to the link:https://circleci.com/developer/orbs[orb registry] and imported into multiple configuration files.
17
+
* URL orbs can be stored anywhere that can be accessed by your CircleCI project, and are referenced by a URL to import into your configuration files.
18
+
19
+
If you manage multiple, similar projects, consider abstracting out your config with orbs.
20
+
21
+
== Prerequisites
18
22
19
23
Before authoring an orb, it is recommended that you become familiar with the xref:config-intro#[CircleCI config] and authoring xref:reusing-config#[parameterized reusable config elements] pages.
20
24
@@ -26,12 +30,12 @@ Orbs consist of three main elements:
26
30
27
31
Practice with xref:reusing-config#writing-inline-orbs[inline orbs]. Inline orbs can be defined within a single config file for testing.
28
32
29
-
NOTE: Orb authors automatically agree to the CircleCI link:https://circleci.com/legal/code-sharing-terms/[Code Sharing Terms of Service]. All publicly published orbs are made available on the Orb Registry under the link:https://opensource.org/licenses/MIT[MIT License agreement]. For more information, see link:https://circleci.com/developer/orbs/licensing[Orb Licensing].
33
+
NOTE: Registry orb authors automatically agree to the CircleCI link:https://circleci.com/legal/code-sharing-terms/[Code Sharing Terms of Service]. All publicly published orbs are made available on the Orb Registry under the link:https://opensource.org/licenses/MIT[MIT License agreement]. For more information, see link:https://circleci.com/developer/orbs/licensing[Orb Licensing].
30
34
31
-
CAUTION: Once an orb is created it cannot be deleted. Orbs are link:https://semver.org/[SemVer compliant], and each published version is immutable. Publicly released orbs are potential dependencies for other projects. Therefore, allowing orb deletion would make users susceptible to unexpected loss of functionality.
35
+
CAUTION: Once a registry orb is created it cannot be deleted. Registry orbs are link:https://semver.org/[SemVer compliant], and each published version is immutable. Publicly released orbs are potential dependencies for other projects. Therefore, allowing orb deletion would make users susceptible to unexpected loss of functionality.
In the example above, the `test` job in the workflow is being overridden with the orb job `my-orb/my-test`. The `my-orb/my-test` job might be defined with a different resource class or execution steps.
2483
+
2484
+
If the `my-orb/my-test` job is not defined inside the orb, the `test` job will compile using the local job definition.
2485
+
2486
+
'''
2487
+
[#serial-group]
2458
2488
====== `serial-group`
2459
2489
2460
2490
The `serial-group` key is used to add a property to a job to allow a group of jobs to run in series, rather than concurrently, across an organization. Serial groups control the orchestration of jobs across an organization, not just within projects and pipelines.
Copy file name to clipboardExpand all lines: jekyll/_cci2/create-an-orb.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ circleci update
37
37
38
38
circleci version
39
39
```
40
-
* xref:orb-author-intro#register-a-namespace[Register a namespace] for your GitHub organization. Ensure the organization on GitHub is the owner for the CircleCI namespace for which you are developing your orb. This will be automatically configured correctly if you are using your own personal organization and namespace.
40
+
* xref:orb-author#register-a-namespace[Register a namespace] for your GitHub organization. Ensure the organization on GitHub is the owner for the CircleCI namespace for which you are developing your orb. This will be automatically configured correctly if you are using your own personal organization and namespace.
Copy file name to clipboardExpand all lines: jekyll/_cci2/deployment-overview.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ workflows:
78
78
79
79
Under the hood, this orb creates, bundles, and deploys your application using your specified parameters set under the `aws-code-deploy/deploy` job declaration.
80
80
81
-
Check out the full range of available orbs in the link:https://circleci.com/developer/orbs[orbs registry]. If the orb you need has not been created yet, consider xref:orb-author-intro#[authoring one]!
81
+
Check out the full range of available orbs in the link:https://circleci.com/developer/orbs[orbs registry]. If the orb you need has not been created yet, consider xref:orb-author#[authoring one]!
0 commit comments