Repository navigation
fix: update docs - #455
Open
botanical wants to merge 2 commits into
Open
fix: update docs#455botanical wants to merge 2 commits into
botanical wants to merge 2 commits into
Conversation
jjfrench
reviewed
Oct 1, 2026
jjfrench
left a comment
jjfrench
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the docs additions ❤️
|
|
||
| The workflows read config from two GitHub Environments (under Settings -> Environments): `staging` and `production`. A job only sees the secrets and vars of the environment it declares. The same secret name, therefore, can hold a different value in each stage. | ||
|
|
||
| ## Which workflow uses which environment |
Contributor
There was a problem hiding this comment.
I could see a comprehensive environment table for each environment being useful for readability - could maybe consolidate the table below, then too
| | -- | -- | -- | -- | -- | | ||
| | STAGING_AIRFLOW_API_VERSION | Staging GitHub Env | Staging Publish/Promotion | 2 | The Airflow Version for the Staging Environment. For Airflow 2 = API v1 + Basic auth, Airflow 3 = API v2 + JWT | | ||
| | PRODUCTION_AIRFLOW_API_VERSION | Production GitHub Env | Production Promotion | 2 | Same as above | | ||
| | AIRFLOW_JWT_SECRET | Both (optional) | Any Publish/Promotion step that uses Airflow 3 | none | Conditionally required when the resolved API version is 3. Must match the secret that the Airflow 3 deployment signs with. Can be found in Secrets Manager | |
Contributor
There was a problem hiding this comment.
Both - referring to Staging and Production GitHub Env?
Member
Author
There was a problem hiding this comment.
yes! should I make that more clear?
jjfrench
reviewed
Oct 1, 2026
| - Secrets, for a staging instance using Airflow 3, `AIRFLOW_JWT_SECRET` and `AIRFLOW_JWT_SUB`. | ||
| - Secret for the MDX PR step: `APP_PEM`. | ||
| - Vars: `STAGING_SM2A_API_URL`, `STAGING_AIRFLOW_API_VERSION`, `DATASET_DAG_NAME`, and `ARTIFACT_RETENTION_DAYS`. | ||
| - Vars for the MDX step: `SKIP_MDX_PR_STEP`, `VEDA_CONFIG_REPO_ORG`, `VEDA_CONFIG_REPO_NAME`, `VEDA_CONFIG_APP_ID`, and `GH_ACTOR_EMAIL`. |
Contributor
There was a problem hiding this comment.
Is there a specific reason why "GH_ACTOR_EMAIL" needs to be a var?
Member
Author
There was a problem hiding this comment.
hmm maybe it doesn't need to be a var but we made it this way to be easily configurable (and I believe it's required for the git config setup)
Co-authored-by: Jamison French <50224594+jjfrench@users.noreply.github.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.