From 6bf2bbb2fbabc306ea2d46264bf530490d3c411c Mon Sep 17 00:00:00 2001 From: "gtrivedi@redhat.com" Date: Thu, 28 Sep 2023 20:26:43 +0530 Subject: [PATCH] Updated the content for clarity --- .../ROOT/pages/how-to-guides/proc_hermetic-builds.adoc | 4 ++-- ...oc_prefetching-dependencies-to-support-hermetic-build.adoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/modules/ROOT/pages/how-to-guides/proc_hermetic-builds.adoc b/docs/modules/ROOT/pages/how-to-guides/proc_hermetic-builds.adoc index a91fd18c..c21b7263 100644 --- a/docs/modules/ROOT/pages/how-to-guides/proc_hermetic-builds.adoc +++ b/docs/modules/ROOT/pages/how-to-guides/proc_hermetic-builds.adoc @@ -21,7 +21,7 @@ To create a hermetic build for a component, complete the following steps: . Go to the `.tekton` directory in the repository of your component and locate the *.yaml* files related to the *pull-request* and *push* processes. -. Configure the hermetic pipeline by adding the following hermetic pipeline parameters in both the *.yaml* files: +. To configure the hermetic pipeline in both the *.yaml* files, add the following hermetic pipeline parameters to the `spec.params` section: + [source,yaml] @@ -38,7 +38,7 @@ spec: ==== * In a non-java application, that is a link:https://github.com/redhat-appstudio/build-definitions/blob/main/task/buildah/0.1/buildah.yaml[Buildah] task, adding the parameter mentioned above automatically isolates the build from the network, restricting it to only build from dependencies listed in your Git repository. If you need to pull in dependencies from a package manager for one of the xref:how-to-guides/proc_prefetching-dependencies-to-support-hermetic-build.adoc#supported-languages[supported languages], see xref:how-to-guides/proc_prefetching-dependencies-to-support-hermetic-build.adoc[Prefetching the package manager dependencies for the Hermetic build]. -* When adding the parameters mentioned above, you can safely ignore the default values for the link:https://github.com/burrsutter/partner-catalog-stage/blob/e2ebb05ba8b4e842010710898d555ed3ba687329/.tekton/partner-catalog-stage-wgxd-pull-request.yaml#L87[`pipelineSpec.params`] in the *.yaml* files. +* Do not add these parameters to the link:https://github.com/burrsutter/partner-catalog-stage/blob/e2ebb05ba8b4e842010710898d555ed3ba687329/.tekton/partner-catalog-stage-wgxd-pull-request.yaml#L87[`pipelineSpec.params`] section, as it should always display the default values for hermetic builds. ==== . Create a pull request (PR) by committing your changes to the repository of the component. diff --git a/docs/modules/ROOT/pages/how-to-guides/proc_prefetching-dependencies-to-support-hermetic-build.adoc b/docs/modules/ROOT/pages/how-to-guides/proc_prefetching-dependencies-to-support-hermetic-build.adoc index aa9d38ad..308125c4 100644 --- a/docs/modules/ROOT/pages/how-to-guides/proc_prefetching-dependencies-to-support-hermetic-build.adoc +++ b/docs/modules/ROOT/pages/how-to-guides/proc_prefetching-dependencies-to-support-hermetic-build.adoc @@ -33,7 +33,7 @@ To create a hermetic build for a component, complete the following steps: . Go to the `.tekton` directory in the repository of your component and locate the *.yaml* files related to the *pull-request* and *push* processes. -. Configure the hermetic pipeline by adding the following hermetic pipeline parameters in both the *.yaml* files: +. To configure the hermetic pipeline in both the *.yaml* files, add the following hermetic pipeline parameters to the `spec.params` section: + [source,yaml] @@ -47,7 +47,7 @@ spec: <1> The `prefetch-input` parameter specifies the path to the directory that has the lockfile and the package metadata files. In the above example, the `.` indicates that the package manager lock file is located in the root of the repository. Additionally, if you have multiple directories, you can provide the path to those directories in the JSON array format. For example, `[{"path": ".", "type": "gomod"}, {"path": "subpath/to/the/other/directory", "type": "gomod"}]`. + -NOTE: When adding the parameters mentioned above, you can safely ignore the default values for the link:https://github.com/burrsutter/partner-catalog-stage/blob/e2ebb05ba8b4e842010710898d555ed3ba687329/.tekton/partner-catalog-stage-wgxd-pull-request.yaml#L90[`pipelineSpec.params`] in the *.yaml* files. +NOTE: Do not add these parameters to the link:https://github.com/burrsutter/partner-catalog-stage/blob/e2ebb05ba8b4e842010710898d555ed3ba687329/.tekton/partner-catalog-stage-wgxd-pull-request.yaml#L87[`pipelineSpec.params`] section, as it should always display the default values for hermetic builds. . Create a pull request (PR) by committing your changes to the repository of the component.