Example script of adding run-script task to pipelines #517
+53
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🚀 Preview is available at: https://pr-517--konflux-docs.netlify.app |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a helpful example script to the documentation for adding a run-script task to build pipelines. The script automates a process that would otherwise be manual and error-prone.
My review includes a few suggestions to improve the documentation's clarity, correctness, and adherence to the style guide:
- Aligning the introductory text with the imperative mood required by the style guide.
- Correcting a potentially confusing inconsistency in a task's SHA256 digest.
- Adding a note about a prerequisite (
yq) for the example script. - Improving the wording of a callout for better readability.
These changes will make the documentation more accurate and easier for users to follow.
modules/patterns/pages/running-user-scripts-on-the-build-pipeline.adoc
Outdated
Show resolved
Hide resolved
modules/patterns/pages/running-user-scripts-on-the-build-pipeline.adoc
Outdated
Show resolved
Hide resolved
modules/patterns/pages/running-user-scripts-on-the-build-pipeline.adoc
Outdated
Show resolved
Hide resolved
tkdchen
force-pushed
the
example-script-of-adding-run-script-task
branch
from
aae19c4 to
8bc4752
Compare
|
🚀 Preview is available at: https://pr-517--konflux-docs.netlify.app |
This commit proposes a script that utilizes pipeline-migration-tool to add run-script to pipelines. That should make it a little bit easier for users by running the script with little initial configuration than opening each YAML file and doing manual YAML modification by copy/paste. Signed-off-by: Chenxiong Qi <[email protected]>
tkdchen
force-pushed
the
example-script-of-adding-run-script-task
branch
from
8bc4752 to
2ad686f
Compare
|
🚀 Preview is available at: https://pr-517--konflux-docs.netlify.app |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit proposes a script that utilizes pipeline-migration-tool to add run-script to pipelines. That should make it a little bit easier for users by running the script with little initial configuration than opening each YAML file and doing manual YAML modification by copy/paste.