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.

Sign up for GitHub

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

Jump to bottom

Configuration overhaul: rename env vars #598

Merged
merged 4 commits into from
May 22, 2024
Merged

Configuration overhaul: rename env vars #598

merged 4 commits into from
May 22, 2024

Conversation

josecelano
Copy link
Member

@josecelano josecelano commented May 22, 2024 •
edited
Loading

Rename env vars:

  • To use standard names for E2E tests. E2E tests should use standard names when vars are not specified for E2E tests. For example: TORRUST_INDEX_TRACKER_API_TOKEN -> TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN.
  • To follow Figment conventions.
  • To improve naming. For example, make them more specific: TORRUST_INDEX_CONFIG -> TORRUST_INDEX_CONFIG_TOML.

@josecelano
feat: [torrust#596] rename common E2E env vars
fc1528d 
We should not use specific names (sufix _E2E) for env vars that are not
specidif for E2E tests. These env vars are generic enva vars also used
in production. They only have different values for the E2E test env.

```
TORRUST_INDEX_E2E_CONFIG             -> TORRUST_INDEX_CONFIG
TORRUST_INDEX_E2E_TRACKER_API_TOKEN  -> TORRUST_INDEX_TRACKER_API_TOKEN
TORRUST_INDEX_E2E_AUTH_SECRET_KEY    -> TORRUST_INDEX_AUTH_SECRET_KEY
TORRUST_INDEX_E2E_PATH_CONFIG        -> TORRUST_INDEX_PATH_CONFIG
```
@josecelano josecelano added the Code Cleanup / Refactoring Tidying and Making Neat label May 22, 2024
@josecelano josecelano added this to the v3.0.0 milestone May 22, 2024
@josecelano josecelano self-assigned this May 22, 2024
@josecelano josecelano linked an issue May 22, 2024 that may be closed by this pull request
Configuration overhaul: rename env vars #596
Closed
@josecelano josecelano marked this pull request as ready for review May 22, 2024 09:21
@josecelano
refactor: [torrust#596] rename env vars
97e3634 
```
TORRUST_INDEX_CONFIG             -> TORRUST_INDEX_CONFIG_TOML
TORRUST_INDEX_PATH_CONFIG        -> TORRUST_INDEX_CONFIG_TOML_PATH
TORRUST_INDEX_TRACKER_API_TOKEN  -> TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN
TORRUST_INDEX_AUTH_SECRET_KEY    -> TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY
```
@josecelano josecelano force-pushed the 596-configuration-overhaul-rename-env-vars branch from a9e8395 to 97e3634 Compare May 22, 2024 09:22
@josecelano
Copy link
Member Author

ACK 97e3634

@josecelano josecelano requested a review from da2ce7 May 22, 2024 09:22
@josecelano josecelano merged commit 1d8d405 into torrust:develop May 22, 2024
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@da2ce7 da2ce7 Awaiting requested review from da2ce7

Assignees

@josecelano josecelano

Labels
Code Cleanup / Refactoring Tidying and Making Neat
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.

Configuration overhaul: rename env vars
1 participant
@josecelano