Update utils provider. Add ignore_errors variable to remote-state (#45)

* Update `utils` provider. Add `ignore_errors` variable to `remote-state`

* Auto Format

* Update `utils` provider. Add `ignore_errors` variable to `remote-state`

Co-authored-by: cloudpossebot <11232728+cloudpossebot@users.noreply.github.com>

Author: aknysh

.github/workflows/auto-readme.yml

@@ -1,7 +1,16 @@
 name: "auto-readme"
 on:
   schedule:
-  # Update README.md nightly
+  # Example of job definition:
+  # .---------------- minute (0 - 59)
+  # |  .------------- hour (0 - 23)
+  # |  |  .---------- day of month (1 - 31)
+  # |  |  |  .------- month (1 - 12) OR jan,feb,mar,apr ...
+  # |  |  |  |  .---- day of week (0 - 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat
+  # |  |  |  |  |
+  # *  *  *  *  * user-name command to be executed
+
+  # Update README.md nightly at 4am UTC
   - cron:  '0 4 * * *'
 
 jobs:
@@ -20,7 +29,7 @@ jobs:
         make init
         make readme/build
         # Ignore changes if they are only whitespace
-        git diff --ignore-all-space --ignore-blank-lines --quiet README.md && git restore README.md
+        git diff --ignore-all-space --ignore-blank-lines --quiet README.md && { git restore README.md; echo Ignoring whitespace-only changes in README; }
 
     - name: Create Pull Request
       # This action will not create or change a pull request if there are no changes to make.

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 Cloud Posse, LLC
+   Copyright 2021-2022 Cloud Posse, LLC
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -346,13 +346,13 @@ Available targets:
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
 | <a name="requirement_external"></a> [external](#requirement\_external) | >= 2.0 |
 | <a name="requirement_local"></a> [local](#requirement\_local) | >= 1.3 |
-| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.7 |
+| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.15 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.7 |
+| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.15 |
 
 ## Modules
 
@@ -504,7 +504,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
 ## Copyrights
 
-Copyright © 2021-2021 [Cloud Posse, LLC](https://cloudposse.com)
+Copyright © 2021-2022 [Cloud Posse, LLC](https://cloudposse.com)
 
 
 

docs/terraform.md

@@ -6,13 +6,13 @@
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
 | <a name="requirement_external"></a> [external](#requirement\_external) | >= 2.0 |
 | <a name="requirement_local"></a> [local](#requirement\_local) | >= 1.3 |
-| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.7 |
+| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 0.17.15 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.7 |
+| <a name="provider_utils"></a> [utils](#provider\_utils) | >= 0.17.15 |
 
 ## Modules
 

examples/complete/versions.tf

@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.7"
+      version = ">= 0.17.15"
     }
   }
 }

examples/remote-state/atmos.yaml

@@ -8,11 +8,20 @@
 # It supports POSIX-style Globs for file names/paths (double-star `**` is supported)
 # https://en.wikipedia.org/wiki/Glob_(programming)
 
+# Base path for components and stacks configurations.
+# Can also be set using `ATMOS_BASE_PATH` ENV var, or `--base-path` command-line argument.
+# Supports both absolute and relative paths.
+# If not provided or is an empty string, `components.terraform.base_path`, `components.helmfile.base_path` and `stacks.base_path`
+# are independent settings (supporting both absolute and relative paths).
+# If `base_path` is provided, `components.terraform.base_path`, `components.helmfile.base_path` and `stacks.base_path`
+# are considered paths relative to `base_path`.
+base_path: "."
+
 components:
   terraform:
     # Can also be set using `ATMOS_COMPONENTS_TERRAFORM_BASE_PATH` ENV var, or `--terraform-dir` command-line argument
     # Supports both absolute and relative paths
-    base_path: "./components/terraform"
+    base_path: "components/terraform"
     # Can also be set using `ATMOS_COMPONENTS_TERRAFORM_APPLY_AUTO_APPROVE` ENV var
     apply_auto_approve: false
     # Can also be set using `ATMOS_COMPONENTS_TERRAFORM_DEPLOY_RUN_INIT` ENV var, or `--deploy-run-init` command-line argument
@@ -22,7 +31,7 @@ components:
   helmfile:
     # Can also be set using `ATMOS_COMPONENTS_HELMFILE_BASE_PATH` ENV var, or `--helmfile-dir` command-line argument
     # Supports both absolute and relative paths
-    base_path: "./components/helmfile"
+    base_path: "components/helmfile"
     # Can also be set using `ATMOS_COMPONENTS_HELMFILE_KUBECONFIG_PATH` ENV var
     kubeconfig_path: "/dev/shm"
     # Can also be set using `ATMOS_COMPONENTS_HELMFILE_HELM_AWS_PROFILE_PATTERN` ENV var
@@ -33,7 +42,7 @@ components:
 stacks:
   # Can also be set using `ATMOS_STACKS_BASE_PATH` ENV var, or `--config-dir` and `--stacks-dir` command-line arguments
   # Supports both absolute and relative paths
-  base_path: "./stacks"
+  base_path: "stacks"
   # Can also be set using `ATMOS_STACKS_INCLUDED_PATHS` ENV var (comma-separated values string)
   included_paths:
     - "**/*"

examples/remote-state/main.tf

@@ -17,3 +17,18 @@ module "remote_state_using_context" {
 
   context = module.this.context
 }
+
+module "remote_state_using_context_ignore_errors" {
+  source = "../../modules/remote-state"
+
+  # Use a wrong component for testing
+  # If `ignore_errors = false`, the `utils` provider will throw the error: Could not find config for the component 'test/test-component-override-wrong' in the stack 'tenant1-ue2-dev'
+  # Note that terraform `try()` does not catch errors from providers, so `try(module.remote_state_using_context_ignore_errors.outputs, {})` will not work
+  ignore_errors = true
+  component     = "test/test-component-override-wrong"
+  tenant        = "tenant1"
+  environment   = "ue2"
+  stage         = "dev"
+
+  context = module.this.context
+}

examples/remote-state/outputs.tf

@@ -7,3 +7,8 @@ output "remote_state_using_context" {
   value       = module.remote_state_using_context.outputs
   description = "Component remote state using the provided context"
 }
+
+output "remote_state_using_context_ignore_errors" {
+  value       = module.remote_state_using_context_ignore_errors.outputs
+  description = "Component remote state using wrong component. Errors are ignored in the 'utils' provider"
+}

examples/remote-state/versions.tf

@@ -12,7 +12,7 @@ terraform {
     }
     utils = {
       source  = "cloudposse/utils"
-      version = ">= 0.17.7"
+      version = ">= 0.17.15"
     }
   }
 }

examples/spacelift/atmos.yaml

@@ -8,11 +8,20 @@
 # It supports POSIX-style Globs for file names/paths (double-star `**` is supported)
 # https://en.wikipedia.org/wiki/Glob_(programming)
 
+# Base path for components and stacks configurations.
+# Can also be set using `ATMOS_BASE_PATH` ENV var, or `--base-path` command-line argument.
+# Supports both absolute and relative paths.
+# If not provided or is an empty string, `components.terraform.base_path`, `components.helmfile.base_path` and `stacks.base_path`
+# are independent settings (supporting both absolute and relative paths).
+# If `base_path` is provided, `components.terraform.base_path`, `components.helmfile.base_path` and `stacks.base_path`
+# are considered paths relative to `base_path`.
+base_path: "."
+
 components:
   terraform:
     # Can also be set using `ATMOS_COMPONENTS_TERRAFORM_BASE_PATH` ENV var, or `--terraform-dir` command-line argument
     # Supports both absolute and relative paths
-    base_path: "./components/terraform"
+    base_path: "components/terraform"
     # Can also be set using `ATMOS_COMPONENTS_TERRAFORM_APPLY_AUTO_APPROVE` ENV var
     apply_auto_approve: false
     # Can also be set using `ATMOS_COMPONENTS_TERRAFORM_DEPLOY_RUN_INIT` ENV var, or `--deploy-run-init` command-line argument
@@ -22,7 +31,7 @@ components:
   helmfile:
     # Can also be set using `ATMOS_COMPONENTS_HELMFILE_BASE_PATH` ENV var, or `--helmfile-dir` command-line argument
     # Supports both absolute and relative paths
-    base_path: "./components/helmfile"
+    base_path: "components/helmfile"
     # Can also be set using `ATMOS_COMPONENTS_HELMFILE_KUBECONFIG_PATH` ENV var
     kubeconfig_path: "/dev/shm"
     # Can also be set using `ATMOS_COMPONENTS_HELMFILE_HELM_AWS_PROFILE_PATTERN` ENV var
@@ -33,7 +42,7 @@ components:
 stacks:
   # Can also be set using `ATMOS_STACKS_BASE_PATH` ENV var, or `--config-dir` and `--stacks-dir` command-line arguments
   # Supports both absolute and relative paths
-  base_path: "./stacks"
+  base_path: "stacks"
   # Can also be set using `ATMOS_STACKS_INCLUDED_PATHS` ENV var (comma-separated values string)
   included_paths:
     - "**/*"