From 26ce1b0fb3a8ec9416e9561b1886ece8c2926958 Mon Sep 17 00:00:00 2001 From: Andrei Palade Date: Thu, 1 May 2025 08:45:53 +0000 Subject: [PATCH 1/3] Add deploy tag --- docs/developer_guide/set_up_dev_env/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/developer_guide/set_up_dev_env/index.rst b/docs/developer_guide/set_up_dev_env/index.rst index c85e6cf1..e66a53ac 100644 --- a/docs/developer_guide/set_up_dev_env/index.rst +++ b/docs/developer_guide/set_up_dev_env/index.rst @@ -207,6 +207,8 @@ Build repo archive and installer packages and move them to default directories: Ensure that the ``TF_VAR_deploy_tag`` is set to the correct version that matches the version of Debian\* packages. Due to Debian versioning, if you are building from a tagged version branch (e.g., v3.0.0), the ``mage build:all`` command will remove the v prefix so you may need to manually export ``TF_VAR_deploy_tag``. +If the ``TF_VAR_deploy_tag`` is set, because of the Terraform's precendence rules, the `deploy_tag` must not be set in the ``terraform/orchestrator/terraform.tfvars`` file. + Edit ``terraform/orchestrator/terraform.tfvars`` to use locally built artifacts: From 3c0dddd63ba96999de2c260b56987796456ce591 Mon Sep 17 00:00:00 2001 From: Andrei Palade Date: Fri, 2 May 2025 10:55:33 +0000 Subject: [PATCH 2/3] Updated the text --- docs/developer_guide/set_up_dev_env/index.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/developer_guide/set_up_dev_env/index.rst b/docs/developer_guide/set_up_dev_env/index.rst index e66a53ac..2aa20b9b 100644 --- a/docs/developer_guide/set_up_dev_env/index.rst +++ b/docs/developer_guide/set_up_dev_env/index.rst @@ -206,8 +206,9 @@ Build repo archive and installer packages and move them to default directories: Ensure that the ``TF_VAR_deploy_tag`` is set to the correct version that matches the version of Debian\* packages. Due to Debian versioning, if you are building from a tagged version branch (e.g., v3.0.0), the ``mage build:all`` command will remove the v prefix so you may need to manually export ``TF_VAR_deploy_tag``. - -If the ``TF_VAR_deploy_tag`` is set, because of the Terraform's precendence rules, the `deploy_tag` must not be set in the ``terraform/orchestrator/terraform.tfvars`` file. +If ``TF_VAR_deploy_tag`` is set, ensure that ``deploy_tag`` is not defined in +the ``terraform/orchestrator/terraform.tfvars`` file due to Terraform's +precedence rules. Edit ``terraform/orchestrator/terraform.tfvars`` to use locally built artifacts: From 0152913be94b32b573092eb44851bd368795665c Mon Sep 17 00:00:00 2001 From: Andrei Palade Date: Fri, 2 May 2025 13:18:47 +0000 Subject: [PATCH 3/3] Update path --- docs/developer_guide/set_up_dev_env/index.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/developer_guide/set_up_dev_env/index.rst b/docs/developer_guide/set_up_dev_env/index.rst index 2aa20b9b..43d4f2db 100644 --- a/docs/developer_guide/set_up_dev_env/index.rst +++ b/docs/developer_guide/set_up_dev_env/index.rst @@ -27,12 +27,11 @@ Your development machine must have the following software installed: - Download the appropriate asdf binary for your operating system/architecture combo from the `GitHub releases page `_. Ensure to place it in a - directory on your $PATH. - - - Prepend ``$ASDF_DATA_DIR/shims`` to your ``$PATH`` environment variable. + directory on your ``$PATH``. For example, you can prepend + ``$ASDF_DATA_DIR/shims`` to your ``$PATH`` environment variable: .. code-block:: bash - + export PATH="${ASDF_DATA_DIR:-$HOME/.asdf}/shims:$PATH" - Docker\* software