Skip to content

Commit dbe1680

Browse files
committed
RHDEVDOCS-6412: Defining Cancel-In-Progress Enhancements for 1.19
Implementing SME review comments RHDEVDOCS-6412: Incorporated peer review comments
1 parent e6fd977 commit dbe1680

4 files changed

+16
-5
lines changed

modules/op-customizing-pipelines-as-code-configuration.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,8 @@ To customize {pac}, cluster administrators can configure the following parameter
4848

4949
| `secret-github-app-scope-extra-repos` | Additional repositories for scoping the generated GitHub access token. |
5050

51+
| `enable-cancel-in-progress-on-pull-requests` | Automatically cancels in-progress pipeline runs for all pull requests when a new commit is added. This ensures the old pipeline run is cancelled only after the new one has successfully started. The `cancel-in-progress` annotation on individual runs still applies and overrides the global setting. | `false`
52+
53+
| `enable-cancel-in-progress-on-push` | Automatically cancels in-progress pipeline runs for all push commits when a new commit is pushed. The old pipeline run is cancelled only after the new one has successfully started. The `cancel-in-progress` annotation on individual runs still applies and overrides this global setting. | `false`
5154

5255
|===

modules/op-speccancel-pipeline-run-using-pipelines-as-code.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,12 @@ annotations:
2626
# ...
2727
----
2828

29+
:FeatureName: Automatic cancellation-in-progress of pipeline runs
30+
include::snippets/technology-preview.adoc[]
31+
2932
[NOTE]
3033
====
31-
{pac} cancels a pipeline run _after_ starting a new copy of this pipeline run successfully. The `pipelinesascode.tekton.dev/cancel-in-progress` setting does _not_ ensure that only one copy of the pipeline run is executing at any time.
32-
====
34+
* {pac} cancels a pipeline run _after_ starting a new copy of this pipeline run successfully. The `pipelinesascode.tekton.dev/cancel-in-progress` setting does _not_ ensure that only one copy of the pipeline run is executing at any time.
3335
34-
:FeatureName: Automatic cancellation-in-progress of pipeline runs
35-
include::snippets/technology-preview.adoc[]
36+
* To enable `cancellation-in-progress` for all default pipeline runs, use the `enable-cancel-in-progress-on-pull-requests` and the `enable-cancel-in-progress-on-push` settings. These settings are available in the `platforms.openshift.pipelinesAsCode.settings` spec of the `TektonConfig` custom resource (CR) configure {pac}.
37+
====

pac/creating-pipeline-runs-pac.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,9 @@ include::modules/op-filtering-pipeline-run-using-pipelines-as-code.adoc[leveloff
3636
* link:https://cel.dev/[Common Expression Language (CEL)]
3737
3838
include::modules/op-speccancel-pipeline-run-using-pipelines-as-code.adoc[leveloffset=+1]
39+
40+
[role="_additional-resources"]
41+
[id="additional-resources-customizing-pipelinerun-as-code_{context}"]
42+
.Additional resources
43+
44+
* xref:../pac/install-config-pipelines-as-code.adoc#customizing-pipelines-as-code-configuration_install-config-pipelines-as-code[Customizing {pac} configuration]

pac/install-config-pipelines-as-code.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ include::modules/op-pac-additional-controller.adoc[leveloffset=+1]
2222
[role="_additional-resources"]
2323
.Additional resources
2424

25-
* xref:../pac/install-config-pipelines-as-code.adoc#customizing-pipelines-as-code-configuration_{context}[Customizing {pac} configuration]
25+
* xref:../pac/install-config-pipelines-as-code.adoc#customizing-pipelines-as-code-configuration_install-config-pipelines-as-code[Customizing {pac} configuration]
2626
2727
* xref:../pac/using-pipelines-as-code-repos.adoc#pac-configuring-github-app-manually_using-pipelines-as-code-repos[Configuring a GitHub App manually and creating a secret for {pac}]
2828

0 commit comments

Comments
 (0)