Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit37915e5

Browse files
committed
Update how to articles
Continued to edit how to articles
1 parent130dd6e commit37915e5

File tree

4 files changed

+60
-44
lines changed

4 files changed

+60
-44
lines changed

‎_docs/kb/articles/debug-mode-cli.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,42 @@ categories: [Pipelines, CLI]
1111
support-reviewed:2023-04-18 LG
1212
---
1313

14-
##Overview
14+
This article describes how to enable debug mode when using the Codefresh CLI for pipeline management.
15+
Enabling the`debug` mode provides detailed output helping you to understand the reasons for potential issues.
1516

16-
When you're running commands using Codefresh CLI you may face some issues related to:
17+
Debig mode is useful when facing issues related to:
18+
* Authentication
19+
* Network access, such as connectivity to the Codefresh platform
20+
* Delays or errors during command execution, as when running a pipeline locally
1721

18-
* Authentication problems
19-
* Network-related issues (e.g.: trying to reach Codefresh platform)
20-
* Delays or errors executing a command (e.g.: running a pipeline locally)
22+
>**NOTE**
23+
Make sure you have the[latest version of the CLI](https://codefresh-io.github.io/cli/installation/){:target="\_blank"}.
2124

22-
By enabling the`debug` mode when using the Codefresh CLI, you will get more verbose output, which will help you to understand where and when a potential issue is happening.
25+
##How to
2326

24-
##Details
25-
26-
1. Enable the`debug` mode for the Codefresh CLI: to do so, you need to initialize the`DEBUG` environment variable as follows:
27+
1. Initialize the`DEBUG` environment variable:
2728

2829
```shell
2930
DEBUG=codefresh*
3031
```
3132

32-
2. Run the Codefresh CLIcommand you would like to debug. For example:
33+
1. Run the Codefresh CLIcommand you want to debug.
34+
For example:
3335

3436
```shell
3537
codefresh run my-project/my-pipeline --local
3638
```
3739

38-
(or any other Codefresh CLI command)
39-
40-
3. You will get an output similar to this:
40+
1. Analyze the output to identify issues.
41+
Below is an example of CLIcommand outputin debug mode.
4142

4243
![Codefresh CLI debug output]({{site.baseurl}}/images/troubleshooting/cli-debug-mode.png)
4344

44-
>**_Note:_**
45-
>
46-
>If after reviewing the output provided by the debug mode you're still unable to fix the issue, please include that output in a ticket. That way the Support Team will be able to help you.
45+
{{site.data.callout.callout_tip}}
46+
**TIP**
47+
If after analyzing the debug output you're unable to resolve the issue, please submit a ticket to Codefresh Support, including the output details.
48+
{{site.data.callout.end}}
4749
48-
## Related Items
50+
## Related articles
51+
[Codefresh CLI documentation](https://codefresh-io.github.io/cli/)
4952
50-
* [Codefresh CLI documentation](https://codefresh-io.github.io/cli/)
51-
* [Codefresh CLI Installation and upgrade process](https://codefresh-io.github.io/cli/installation/) (it's important to keep your Codefresh CLI up to date)

‎_docs/kb/articles/disable-status-updates-to-github.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,23 @@ categories: [Pipelines, CLI, Settings]
1111
support-reviewed:2023-04-18 LG
1212
---
1313

14-
##Overview
1514

16-
You need to option to stop status update to github from a pipeline
1715

18-
##Details
16+
This article describes how to stop status update from a pipeline to GitHub.
1917

20-
To disable status updates to Github, please follow these steps (it's currently supported only via CLI):
18+
>**NOTE**
19+
Disabling status updates to GitHub is currently supported only via CLI for Codefresh pipelines.
2120

22-
1. Install the Codefresh CLI:<https://codefresh-io.github.io/cli/installation/>
21+
##Before you begin
2322

24-
2. Authenticate the CLI to your Codefresh account:<https://codefresh-io.github.io/cli/authentication/>
23+
* Install the CLI](https://codefresh-io.github.io/cli/installation/){:target="\_blank"}
24+
*[Authenticate the CLI to your Codefresh account](https://codefresh-io.github.io/cli/authentication/){:target="\_blank"}
2525

26-
3. Run`codefresh get pipeline <project_name/pipeline_name> -o yaml > pipeline_name_spec.yaml` to export the full pipeline spec as a YAML file
26+
##How to
2727

28-
4. Add the options section under`spec`, set`enableNotifications: false` and save the changes. The updated YAML should look like this:
28+
1. Export the full pipeline spec as a YAML file:
29+
`codefresh get pipeline <project_name/pipeline_name> -o yaml > pipeline_name_spec.yaml` to
30+
1. Below`spec`, add`options` and then add`enableNotifications: false`, as in the example below.
2931

3032
```yaml
3133
version:'1.0'
@@ -35,5 +37,5 @@ To disable status updates to Github, please follow these steps (it's currently s
3537
options:
3638
enableNotifications:false
3739
```
38-
39-
5. Run the`codefresh replace pipeline -f pipeline_name_spec.yaml` to update your pipeline from the YAML file
40+
1. Save the changes and close the YAML.
41+
5. Run the`codefresh replace pipeline -f pipeline_name_spec.yaml` to update your pipelinewith the specificationsfrom the YAML file.

‎_docs/kb/articles/ensure-cleanup-when-pipelines-stops.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title:"How To:Ensure Clean Up CommandsAlwaysRun If a Pipeline Is Manually Stopped"
2+
title:"How To: Alwaysrun clean-up commands after pipeline execution"
33
description:
44
group:kb
55
sub-group:articles
@@ -11,13 +11,21 @@ categories: [Pipelines]
1111
support-reviewed:2023-05-04 LG
1212
---
1313

14-
##Overview
1514

16-
Sometimes you might want to run code at the end of every pipeline (eg to clean up resources) regardless of success, failure, or the pipeline is manually stopped.
1715

18-
##Details
16+
This article describes how to insert a parallel step within a sequential pipeline to run specific commands at the end of pipeline execution. A common use case for this approach is automating resource cleanup tasks.
1917

20-
When working with a sequential (default) pipeline, you will find that manually stopping a pipeline halts the entire pipeline - including any pipeline hooks set to run on_success or on_failure[1]. However, if you switch the entire pipeline work in parallel[2], you can use the below step as a template to ensure that your clean up code will always run:
18+
The parallel step always runs at the end of the pipeline, regardless of its build status, or if the pipeline was manually terminated.
19+
20+
21+
22+
##How to
23+
24+
In a sequential pipeline, which is the default execution mode for pipelines, manually terminating the pipeline, also terminates the execution of subsequent steps, including any pipeline hooks set to run on success or failure.
25+
26+
You can circumvent this behavior by inserting a parallel step within the pipeline.
27+
28+
* Add the step below as a template to ensure code clean-up will always run:
2129

2230
```yaml
2331
cleaner_always_executed:
@@ -32,8 +40,6 @@ cleaner_always_executed:
3240
buildSuccess:workflow.result == 'success'
3341
```
3442
35-
## Related Items
36-
37-
[1] <https://codefresh.io/docs/docs/pipelines/hooks/>
38-
39-
[2] <https://codefresh.io/docs/docs/pipelines/advanced-workflows/#parallel-pipeline-mode>
43+
## Related articles
44+
[Hooks in pipelines]({{site.baseurl}}/docs/pipelines/hooks/)
45+
[Parallel pipeline execution]({{site.baseurl}}/docs/pipelines/advanced-workflows/#parallel-pipeline-execution)
Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title:"How To: FindPipelines Using a SpecificGitIntegration"
2+
title:"How To: Findpipelines using specificGitintegration"
33
description:
44
group:kb
55
sub-group:articles
@@ -11,15 +11,22 @@ categories: [CLI, Pipelines]
1111
support-reviewed:2023-04-18 LG
1212
---
1313

14-
##Overview
1514

16-
You have an old git context and are unabletodelete theintegration. Or you wanttomigrate to a new GitIntegration.
15+
This article describes howtouse theCodefresh CLItofind pipelines with legacy Gitcontexts.
1716

18-
##Details
17+
>**NOTE**
18+
You need JQuery installed for the command below.
1919

20-
Run the following CLI command to get the names of pipelines that reference the Git Integration for a Trigger, using to get YAML from Repository, or specified in a git-clone step while using an Inline YAML. You will need to have JQ installed for this to work.
20+
##How to
21+
22+
Get the names of pipelines that reference the Git integration for a trigger.
23+
The command below supports pipelines with source YAMLs from Git repositories, or those that reference the Git integration in a`git-clone` step with inline YAML.
24+
25+
* Run:
2126

2227
```shell
2328
codefresh get pip --limit 100 -o json|\
2429
jq --arg v"GIT_INTEGRATION" -r'.[] | select(contains({"spec":{"triggers":[{"type":"git", "context":$v}]}}) or contains({"spec":{"specTemplate":{"context":$v}}}) or contains({"spec":{"steps":$v}})) | .metadata.name'
2530
```
31+
##Related articles
32+
[Creating a pipeline]({{site.baseurl}}/docs/pipelines/pipelines/#creating-a-pipeline)

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp