fix: support docker/.env-local for docker-compose #28039
Merged
Conversation
This file contains 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
As reported here #28026, in #27953 I added support for a supplemental `docker/.env-local` override file, not thinking it was going to be required upon starting docker-compose. I thought I had tested that while switching branches but somehow didn't test that docker-compose would simply boot up in the absence of that file. Since this is confusing to most, and we don't really have a script I can latch onto to `touch docker/.env-local` for now, i decided to backtrack and simply remove the convenience "feature". People should find an alternate way to alter their environment somehow before starting the service. I added a bit of documentation to point to an existing mechanism around providing a `docker/pythonpath_dev/superset_config_docker.py` file, which existed in the logic but wasn't clearly documented. This solves for my use case where I was working a PR adding features around Slack, where I wanted to provide an API key configuration without risks of commiting/pushing it back to the repo.
github-actions
bot
added
doc
3 tasks
mistercrunch
changed the title
mistercrunch
commented
Apr 15, 2024
| @@ -110,7 +110,6 @@ release.json | |||
| messages.mo | |||
|
|
|||
| docker/requirements-local.txt | |||
| docker/.env-local | |||
There was a problem hiding this comment.
turns out that's covered by docker/*local* bellow
|
@artofcomputing please feel free to leave a review if you're so inclined :) |
rusackas
approved these changes
Apr 15, 2024
|
docker-compose is getting very usable for dev workflows - having it boot fast from my previous PR makes it much more viable too |
|
NICE! I'm feeling like CI / docker / docker-compose is getting to a pretty good place. |
qleroy
pushed a commit
to qleroy/superset
that referenced
this pull request
Apr 28, 2024
jzhao62
pushed a commit
to jzhao62/superset
that referenced
this pull request
May 16, 2024
vinothkumar66
pushed a commit
to vinothkumar66/superset
that referenced
this pull request
Nov 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As reported here #28026, in #27953 I added support for a supplemental
docker/.env-localoverride file, not thinking it was going to be required upon starting docker-compose. I thought I had tested that while switching branches but somehow didn't test that docker-compose would simply boot up in the absence of that file.BUT! luckily there's a new feature as of docker-compose
2.24.0where there's a way to specify required and not-required files here, so I'm taking advantage of that in this correction PR. Kudos to @artofcomputing for finding this new feature and for pointing this out!I also added a bit of documentation to point to an existing mechanism around providing a
docker/pythonpath_dev/superset_config_docker.pyfile, which existed in the logic but wasn't clearly documented. Thissolves for my use case where I was working a PR adding features around Slack, where I wanted to provide an API key configuration without risks of commiting/pushing it back to the repo.
closes #28026