Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pipeline-faq.md #8922

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion kb/platform/pipeline-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,30 @@ If the test pipeline fails, you can utilize the rollback feature to revert the d

No, currently there is no way to fully integrate a triggered test pipeline within the original deployment pipeline. The test pipeline will always operate as a separate entity.

### Can I fetch the name of the input set used during pipeline runtime?
No, currently, there is no built-in functionality in Harness to retrieve the name of the input set used during the runtime of a pipeline.

### How can I identify which input set was used when triggering a pipeline?
At present, Harness does not provide a way to identify the name of the input set being used in the pipeline during its runtime. You may need to track this information externally or rely on other mechanisms outside the pipeline to document which input set was used.

### How can I improve the visibility of pipeline failures in the dashboard?
Currently, the dashboard only displays generic exit codes like `exit 1` or `exit 2`.

### Is there a way to customize error messages for specific exit codes in a pipeline?
Currently, there is no built-in support to directly customize error messages for different exit codes. However, you can enhance your pipeline by implementing custom scripts or steps that generate detailed messages for each exit code.

### Does the behaviour of error handling differ between step types in the pipeline?
Yes, the behaviour can vary depending on the type of step. For instance, Shell Script steps and Deploy steps may handle errors differently, requiring tailored solutions for each type.

### Are there tools within the pipeline to differentiate exit codes and log appropriate messages?
This functionality is not natively supported at the moment. Enhancing this requires creating custom solutions, such as appending detailed error logs based on exit codes in the pipeline scripts or configurations.

### What steps can be taken to implement better error visibility for different pipeline steps?
You can define custom handling for each type of step in your pipeline. For instance:
- Add error message mapping for exit codes in Shell Script steps.
- Include custom logging logic in the Deploy steps.
This approach ensures more detailed information is displayed in your dashboard for various pipeline failures.

## API

### Can I run pipelines through the API or CLI?
Expand Down Expand Up @@ -729,4 +753,4 @@ Discrepancies arise when the YAML file in any Git branch has different values co

When you make updates to the pipeline via the Harness UI, these changes are saved both to the Harness DB and to the YAML file in the selected Git branch. However, other branches in your repository may still carry outdated YAML files with old values.

To maintain consistency across all branches and interfaces, ensure that any manual changes to the YAML in Git are synchronized with updates made in the Harness UI. It’s also a good practice to regularly update all relevant branches to keep them aligned with the Harness DB.
To maintain consistency across all branches and interfaces, ensure that any manual changes to the YAML in Git are synchronized with updates made in the Harness UI. It’s also a good practice to regularly update all relevant branches to keep them aligned with the Harness DB.
Loading