Skip to content

Commit

Permalink
WIP doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
doshitan committed Jan 3, 2025
1 parent 23e9362 commit d6f9c86
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion template-only-docs/set-up-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Once you have set up your application environments (at least `dev`), you can
enable continuous deployment by running:

```sh
nava-platform infra update --data app_has_dev_env_setup=true .
nava-platform infra update --answers-only --data app_has_dev_env_setup=true
```

And update the `role-to-assume` with the GitHub actions ARN.
2 changes: 1 addition & 1 deletion template-only-docs/set-up-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Some checks are disabled until you've completed certain setup steps:
After [setting up the app environment](/docs/infra/set-up-app-env.md), run:

```sh
nava-platform infra update --data app_has_dev_env_setup=true .
nava-platform infra update --answers-only --data app_has_dev_env_setup=true .
```

If you setup your AWS account in a different region than `us-east-1`, update the `aws-region` workflow settings to match your region.
2 changes: 1 addition & 1 deletion template-only-docs/set-up-pr-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
[Pull request environments](/docs/infra/pull-request-environments.md) are temporary environments that exist during a pull request. Enable them after [setting up the app environment](/docs/infra/set-up-app-env.md):

- In [ci-{{app_name}}-pr-environment-checks.yml](/.github/workflows/ci-{{app_name}}-pr-environment-checks.yml.jinja) and [ci-{{app_name}}-pr-environment-destroy.yml](/.github/workflows/ci-{{app_name}}-pr-environment-destroy.yml.jinja), search for `!!`.
- Uncomment the PR environment triggers for spot testing. Run `nava-platform infra update --data app_has_dev_env_setup=true .` to consistently enable things.
- Uncomment the PR environment triggers for spot testing. Run `nava-platform infra update-app --answers-only --data app_has_dev_env_setup=true . <APP_NAME>` to consistently enable things.

You can verify that PR environments are working by opening a new PR and waiting for the "PR Environment Update" job to finish.
2 changes: 1 addition & 1 deletion templates/app/.github/workflows/cd-{{app_name}}.yml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ on:
# !! Once you've set up the dev environment and are ready to enable continuous
# deployment, run:
#
# nava-platform infra update --data app_has_dev_env_setup=true .
# nava-platform infra update-app --answers-only --data app_has_dev_env_setup=true . {{app_name}}
#
# to enable these lines. They are here as comments for context.
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ on:
# !! Once you've set up the dev environment and are ready to enable automated
# infra tests, run:
#
# nava-platform infra update --data app_has_dev_env_setup=true .
# nava-platform infra update-app --answers-only --data app_has_dev_env_setup=true . {{app_name}}
#
# to enable these lines. They are here as comments for context.
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ on:
# !! Once you've set up the dev environment and are ready to enable PR
# environments, run:
#
# nava-platform infra update --data app_has_dev_env_setup=true .
# nava-platform infra update-app --answers-only --data app_has_dev_env_setup=true . {{app_name}}
#
# to enable these lines. They are here as comments for context.
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
# !! Once you've set up the dev environment and are ready to enable PR
# environments, run:
#
# nava-platform infra update --data app_has_dev_env_setup=true .
# nava-platform infra update-app --answers-only --data app_has_dev_env_setup=true . {{app_name}}
#
# to enable these lines. They are here as comments for context.
#
Expand Down

0 comments on commit d6f9c86

Please sign in to comment.