You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ma...@apache.org on 2025/03/11 21:10:35 UTC
(superset) branch eph-envs-docs created (now fb60a5baac)
This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a change to branch eph-envs-docs
in repository https://gitbox.apache.org/repos/asf/superset.git
at fb60a5baac docs: add information about ephemeral environments
This branch includes the following new commits:
new fb60a5baac docs: add information about ephemeral environments
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(superset) 01/01: docs: add information about ephemeral environments
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a commit to branch eph-envs-docs
in repository https://gitbox.apache.org/repos/asf/superset.git
commit fb60a5baac0298531bc900ead6403e2be9876412
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Tue Mar 11 14:09:55 2025 -0700
docs: add information about ephemeral environments
Adding an entry in the docs about how to use/configure ephemeral environments.
---
.github/workflows/ephemeral-env.yml | 6 +++++-
docs/docs/contributing/howtos.mdx | 24 ++++++++++++++++++++++++
2 files changed, 29 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/ephemeral-env.yml b/.github/workflows/ephemeral-env.yml
index 64c68c4aa3..8c53f21e8e 100644
--- a/.github/workflows/ephemeral-env.yml
+++ b/.github/workflows/ephemeral-env.yml
@@ -126,7 +126,11 @@ jobs:
throw new Error("Issue number is not available.");
}
- const body = `@${user} Processing your ephemeral environment request [here](${workflowUrl}). Action: **${action}**.`;
+ const body = `@${user} Processing your ephemeral environment request [here](${workflowUrl}).` +
+ ` Action: **${action}**.` +
+ ` More information on [how to use or configure ephemeral environments]` +
+ `(https://superset.apache.org/docs/contributing/howtos/#gitHub-ephermeral-environments)`;
+
await github.rest.issues.createComment({
owner: context.repo.owner,
diff --git a/docs/docs/contributing/howtos.mdx b/docs/docs/contributing/howtos.mdx
index 0099bd6199..82efabd846 100644
--- a/docs/docs/contributing/howtos.mdx
+++ b/docs/docs/contributing/howtos.mdx
@@ -608,3 +608,27 @@ If using the eslint extension with vscode, put the following in your workspace `
"superset-frontend"
]
```
+
+## GitHub Ephermeral Environments
+
+On any given pull request on GitHub, it's possible to create a temporary environment/deployment
+by simply adding the label `testenv-up` to the PR. This will trigger a GitHub Action that will.
+
+Once you add the `testenv-up` label, a GitHub Action will be triggered that will:
+- build a docker image
+- deploy it in EC2 (sponsored by the folks at [Preset](https://preset.io))
+- write a comment on the PR with a link to the ephemeral environment
+
+For more advanced use cases, it's possible to set a feature flag on the PR body, which will
+take effect on the ephemeral environment. For example, if you want to set the `TAGGING_SYSTEM`
+feature flag to `true`, you can add the following line to the PR body/description:
+
+```
+FEATURE_TAGGING_SYSTEM=true
+```
+
+Simarly, it's possible to disable feature flags with:
+
+```
+FEATURE_TAGGING_SYSTEM=false
+```