Skip to content

Commit

Permalink
docs: Add description for the tools deployment to the AWS guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mkleszcz committed Feb 15, 2024
1 parent 99b5b79 commit 20a02a2
Showing 1 changed file with 12 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ pnpm saas aws set-var SB_DEPLOY_BRANCHES master

### \[Optional\] Set tools env variables

The `tools` package during CI deployment is responsible for uploading the information of the version of deployed
application on specific environment. Then, you will be able to check currently deployed state in the
[version matrix](../../../working-with-sb/dev-tools/version-matrix).

To configure `tools` package env variables follow the example below.

```shell
Expand All @@ -131,6 +135,14 @@ pnpm saas aws set-var SB_TOOLS_HOSTED_ZONE_NAME example.com
pnpm saas aws set-var SB_TOOLS_DOMAIN_VERSION_MATRIX status.example.com
```

:::info

If you set `SB_TOOLS_ENABLED` to `true` make sure to deploy **version matrix** component before first CI pipeline run.

Follow the [deployment instructions](../../../working-with-sb/dev-tools/version-matrix#deployment) for more details.

:::

## Env variable validation

You can look up the validator in `packages/internal/cli/src/config/env.ts`, which runs on every `nx` command that
Expand Down

0 comments on commit 20a02a2

Please sign in to comment.