Document "env" step

[lkysow]

#751 added a new custom step type:

workflows:
  default:
    plan:
      steps:
     # Set TEST=123
      - env:
           name: TEST
           value: 123
      - run: echo $TEST # Will echo 123

     # Set TEST=123 by running the command.
      - env:
           name: TEST
           command: echo 123
      - run: echo $TEST # Will echo 123

This needs to be documented.

[lkysow]

@anasinnyk are you able to find your commit where you had the documentation?

[k-k]

@lkysow Should probably update the release notes for v0.9.0 - to show the step is env not var.

[lkysow]

@kmfk 🤦‍♂ thanks!

[smiller171]

Does variable expansion (especially command expansion) work in the env step?

[lkysow]

Given

- env:
    name: NAME
    command: "command string"

We run:

sh -c "command string"

So command expansion should work.

[cdenneen]

@lkysow not sure what I'm doing wrong here or if this needs updated documentation but in my repo I have the following atlantis.yaml:

version: 3
workflows:
  default:
    plan:
      steps:
      - env:
          name: TF_VAR_aws_account_id
          value: "111111111111"
      - env:
          name: TF_VAR_gitlab_token
          command: 'echo "$ATLANTIS_GITLAB_TOKEN"'
      - env:
          name: TF_VAR_aws_region
          value: "us-east-1"
      - env:
          name: TF_VAR_account_name
          value: "awsdev"

but when it runs Atlantis shows:

╷
│ Error: No value for required variable
│ 
│   on variables.tf line 27:
│   27: variable "account_name" {
│ 
│ The root module input variable "account_name" is not set, and has no
│ default value. Use a -var or -var-file command line argument to provide a
│ value for this variable.
╵
╷
│ Error: No value for required variable
│ 
│   on variables.tf line 30:
│   30: variable "aws_account_id" {
│ 
│ The root module input variable "aws_account_id" is not set, and has no
│ default value. Use a -var or -var-file command line argument to provide a
│ value for this variable.
╵
╷
│ Error: No value for required variable
│ 
│   on variables.tf line 38:
│   38: variable "gitlab_token" {
│ 
│ The root module input variable "gitlab_token" is not set, and has no
│ default value. Use a -var or -var-file command line argument to provide a
│ value for this variable.
╵
╷
│ Error: No value for required variable
│ 
│   on variables.tf line 58:
│   58: variable "aws_region" {
│ 
│ The root module input variable "aws_region" is not set, and has no default
│ value. Use a -var or -var-file command line argument to provide a value for
│ this variable.

[jamengual]

please create a new issue if is necessary, Luke does not work on the project anymore.