Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify account usage, and document global case #258

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

pdecat
Copy link
Member

@pdecat pdecat commented Oct 10, 2023

Resolves #246

@github-actions
Copy link

Coverage report

Note

Coverage data for the default branch was not found.
This usually happens when the action has not run on the default
branch yet, for example right after deploying it into the workflows.

The coverage rate is 0%.

None of the new lines are part of the tested code. Therefore, there is no coverage data about them.

@pdecat pdecat self-assigned this Oct 10, 2023
@pdecat pdecat requested review from BzSpi and Shr3ps October 10, 2023 05:57
@pdecat pdecat merged commit da2c3d2 into master Oct 10, 2023
12 checks passed
@pdecat pdecat deleted the docs/global_env branch October 10, 2023 06:48
Comment on lines +487 to +490
- `account`: an account alias which may refer to provider accounts or subscriptions, e.g. `project-a-prod`, `customer-b-dev`.
- `environment`: `production`, `preproduction`, `dev`, etc. With `global` as a special case eliminating the `region` part.
- `region`: `eu-west-1`, `westeurope`, etc.
- `stack`: defaults to `default`. `web`, `admin`, `tools`, etc.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This from #246 (comment)

does not contain / or _ characters.

actually is an undocumented requirement.
Being ANAL here: it is left to be deduced by a reader from the ${account}_${environment}_${region}_${stack}.yml and the fact that if _-s are used as separators, then likely those can't be used in names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Missing explanation of account term and relation to config
3 participants