diff --git a/task/prefetch-dependencies-oci-ta/0.1/README.md b/task/prefetch-dependencies-oci-ta/0.1/README.md index fa66e7c565..023454d875 100644 --- a/task/prefetch-dependencies-oci-ta/0.1/README.md +++ b/task/prefetch-dependencies-oci-ta/0.1/README.md @@ -5,6 +5,24 @@ application source code are stored as a trusted artifact in the provided OCI rep For additional info on Cachi2, see docs at https://github.com/containerbuildsystem/cachi2#basic-usage. +## Configuration + +Config file must be passed as a YAML string. For all available config options please check +[available configuration parameters] page. + +Example of setting timeouts: + +```yaml +params: + - name: config-file-content + value: | + --- + requests_timeout: 300 + subprocess_timeout:3600 +``` + +[available configuration parameters]: https://github.com/containerbuildsystem/cachi2?tab=readme-ov-file#available-configuration-parameters + ## Parameters |name|description|default value|required| |---|---|---|---| diff --git a/task/prefetch-dependencies-oci-ta/0.1/prefetch-dependencies-oci-ta.yaml b/task/prefetch-dependencies-oci-ta/0.1/prefetch-dependencies-oci-ta.yaml index b849e81c4c..0ef22d1002 100644 --- a/task/prefetch-dependencies-oci-ta/0.1/prefetch-dependencies-oci-ta.yaml +++ b/task/prefetch-dependencies-oci-ta/0.1/prefetch-dependencies-oci-ta.yaml @@ -14,6 +14,24 @@ spec: application source code are stored as a trusted artifact in the provided OCI repository. For additional info on Cachi2, see docs at https://github.com/containerbuildsystem/cachi2#basic-usage. + + ## Configuration + + Config file must be passed as a YAML string. For all available config options please check + [available configuration parameters] page. + + Example of setting timeouts: + + ```yaml + params: + - name: config-file-content + value: | + --- + requests_timeout: 300 + subprocess_timeout:3600 + ``` + + [available configuration parameters]: https://github.com/containerbuildsystem/cachi2?tab=readme-ov-file#available-configuration-parameters params: - name: SOURCE_ARTIFACT description: The Trusted Artifact URI pointing to the artifact with diff --git a/task/prefetch-dependencies-oci-ta/0.1/recipe.yaml b/task/prefetch-dependencies-oci-ta/0.1/recipe.yaml index 7856c82c41..1b4906f27c 100644 --- a/task/prefetch-dependencies-oci-ta/0.1/recipe.yaml +++ b/task/prefetch-dependencies-oci-ta/0.1/recipe.yaml @@ -27,6 +27,24 @@ description: |- application source code are stored as a trusted artifact in the provided OCI repository. For additional info on Cachi2, see docs at https://github.com/containerbuildsystem/cachi2#basic-usage. + + ## Configuration + + Config file must be passed as a YAML string. For all available config options please check + [available configuration parameters] page. + + Example of setting timeouts: + + ```yaml + params: + - name: config-file-content + value: | + --- + requests_timeout: 300 + subprocess_timeout:3600 + ``` + + [available configuration parameters]: https://github.com/containerbuildsystem/cachi2?tab=readme-ov-file#available-configuration-parameters preferStepTemplate: true removeWorkspaces: - source diff --git a/task/prefetch-dependencies/0.1/README.md b/task/prefetch-dependencies/0.1/README.md index 71748965b9..b3239c707c 100644 --- a/task/prefetch-dependencies/0.1/README.md +++ b/task/prefetch-dependencies/0.1/README.md @@ -3,6 +3,23 @@ Task that uses Cachi2 to prefetch build dependencies. See docs at https://github.com/containerbuildsystem/cachi2#basic-usage. +## Configuration + +Config file must be passed as a YAML string. For all available config options please check [available configuration parameters] page. + +Example of setting timeouts: + +```yaml +params: + - name: config-file-content + value: | + --- + requests_timeout: 300 + subprocess_timeout:3600 +``` + +[available configuration parameters]: https://github.com/containerbuildsystem/cachi2?tab=readme-ov-file#available-configuration-parameters + ## Parameters |name|description|default value|required| |---|---|---|---| diff --git a/task/prefetch-dependencies/0.1/prefetch-dependencies.yaml b/task/prefetch-dependencies/0.1/prefetch-dependencies.yaml index d058fe8c96..a2bedb308d 100644 --- a/task/prefetch-dependencies/0.1/prefetch-dependencies.yaml +++ b/task/prefetch-dependencies/0.1/prefetch-dependencies.yaml @@ -11,6 +11,24 @@ spec: description: |- Task that uses Cachi2 to prefetch build dependencies. See docs at https://github.com/containerbuildsystem/cachi2#basic-usage. + + ## Configuration + + Config file must be passed as a YAML string. For all available config options please check + [available configuration parameters] page. + + Example of setting timeouts: + + ```yaml + params: + - name: config-file-content + value: | + --- + requests_timeout: 300 + subprocess_timeout:3600 + ``` + + [available configuration parameters]: https://github.com/containerbuildsystem/cachi2?tab=readme-ov-file#available-configuration-parameters params: - description: Configures project packages that will have their dependencies prefetched. name: input