From 6b6b756d23cfeeb18a09806ed821388ba59abfc3 Mon Sep 17 00:00:00 2001 From: Marlon Moser <marlon.moser@adfinis.com> Date: Tue, 26 Nov 2024 11:06:09 +0100 Subject: [PATCH] docs: apply suggestions --- .gitlab/README.md.template | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.gitlab/README.md.template b/.gitlab/README.md.template index 34162eb..c255656 100644 --- a/.gitlab/README.md.template +++ b/.gitlab/README.md.template @@ -578,12 +578,12 @@ See also the official GitLab documentation for it If you want to save runner resources you may disable the unit and integration tests by setting the `SKIP_TESTS` CI/CD variable to `true`. -The Component builds by default a multi-arch image for `linux/amd64` and `linux/arm64`. +The component builds by default a multi-arch image for `linux/amd64` and `linux/arm64`. There are multiple reasons why you might want to change this behavior, like saving runner resources. To configure for what architectures the container image should be built, you can go to the CI/CD variables in the project settings and add a variable called `PLATFORMS`. The value is one or more `OS/ARCH[/VARIANT]`. If you have multiple platforms, they have to be comma separated. -**Keep in mind that the component is tested with linux/amd64 and linux/arm64, +**Keep in mind that the component is tested with `linux/amd64` and `linux/arm64`, other platforms are not officially supported!** You can set the `OPENTOFU_COMPONENT_IMAGE_BUILD_RUNNER_TAG` CI/CD variable to a custom runner tag diff --git a/README.md b/README.md index 584f4d3..f3e7b37 100644 --- a/README.md +++ b/README.md @@ -654,12 +654,12 @@ See also the official GitLab documentation for it If you want to save runner resources you may disable the unit and integration tests by setting the `SKIP_TESTS` CI/CD variable to `true`. -The Component builds by default a multi-arch image for `linux/amd64` and `linux/arm64`. +The component builds by default a multi-arch image for `linux/amd64` and `linux/arm64`. There are multiple reasons why you might want to change this behavior, like saving runner resources. To configure for what architectures the container image should be built, you can go to the CI/CD variables in the project settings and add a variable called `PLATFORMS`. The value is one or more `OS/ARCH[/VARIANT]`. If you have multiple platforms, they have to be comma separated. -**Keep in mind that the component is tested with linux/amd64 and linux/arm64, +**Keep in mind that the component is tested with `linux/amd64` and `linux/arm64`, other platforms are not officially supported!** You can set the `OPENTOFU_COMPONENT_IMAGE_BUILD_RUNNER_TAG` CI/CD variable to a custom runner tag -- GitLab