Skip to content

Commit ca6c96d

Browse files
Merge pull request circleci#4031 from circleci/rosie/pipelines-benefits
update pipelines benefits
2 parents d104431 + a98837b commit ca6c96d

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

jekyll/_cci2/api-intro.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,9 @@ The CircleCI API v2 enables users to be authenticated by simply sending your API
5050

5151
### Pipelines
5252

53-
The CircleCI API v2 includes the use of pipelines to assist you in triggering workflows from the CircleCI API. By enabling pipelines, you can take advantage of specific API use cases such as:
53+
The CircleCI API v2 requires you to enable pipelines on your project. By enabling pipelines, you can also take advantage of the following:
5454

55-
- Use Pipeline parameters to trigger [conditional workflows](https://circleci.com/docs/2.0/pipeline-variables/#conditional-workflows).
56-
- API v2 triggering works with v2.1 config, allowing use of reusable config elements, including orbs.
57-
- You can now enable auto-cancel, within **Advanced Settings**, to abort workflows when new builds are triggered on non-default branches.
58-
59-
For more detailed information on pipelines and how you can use them in your workflows and jobs, please see the following guides:
60-
* [Enabling and Transitioning to Pipelines](https://circleci.com/docs/2.0/build-processing/) guide.
61-
* [Viewing Pipelines in the UI](https://circleci.com/docs/2.0/pipelines/#overview)
62-
* [Pipeline Variables](https://circleci.com/docs/2.0/pipeline-variables/#section=configuration)
55+
{% include snippets/pipelines-benefits.adoc %}
6356

6457
#### Triggering a Pipeline with Parameters Example
6558

jekyll/_cci2/build-processing.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,7 @@ Most projects will have Pipelines enabled by default. Verify the project pipelin
2121

2222
The pipelines feature enables use of the new [API endpoint to trigger builds with workflows](https://circleci.com/docs/api/#trigger-a-new-build-by-project-preview) and the following use cases:
2323

24-
- New API endpoint to trigger builds, including running all workflows in the build.
25-
- Jobs named `build` will be wrapped in a workflows stanza by the processor.
26-
- Projects for which auto-cancel is enabled in the Advanced Settings will have workflows on non-default branches cancelled when a newer build is triggered on that same branch.
27-
- Use of configuration version 2.1 or higher requires pipelines to be turned on.
28-
29-
**Notes:** It is important to carefully consider the impact of enabling the auto-cancel feature, for example, if you have configured automated deployment jobs on non-default branches.
24+
{% include snippets/pipelines-benefits.adoc %}
3025

3126
## Troubleshooting
3227

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
* Use pipeline parameters to trigger [conditional workflows]({{ site.baseurl }}/2.0/pipeline-variables/#conditional-workflows).
2+
* Access to `version 2.1` config, which provides:
3+
* [Resuable config]({{ site.baseurl }}/2.0/reusing-config/) elements, including executors, commands and jobs.
4+
* Packaged resuable config, known as [orbs](https://circleci.com/orbs/).
5+
* Improved config validation error messages.
6+
- You can now enable auto-cancel, within **Advanced Settings**, to abort workflows when new builds are triggered on non-default branches.
7+
8+
**Note**, it is important to carefully consider the impact of enabling the auto-cancel feature, for example, if you have configured automated deployment jobs on non-default branches.
9+
10+
For more detailed information on pipelines and how you can use their properties in your workflows and jobs, please see the following guides:
11+
* [Transitioning to Pipelines]({{ site.baseurl }}/2.0/build-processing/#transitioning-to-pipelines)
12+
* [Viewing Pipelines in the UI]({{ site.baseurl }}/2.0/pipelines/#overview)
13+
* [Pipeline Variables]({{ site.baseurl }}/2.0/pipeline-variables/)

0 commit comments

Comments
 (0)