You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "polRk (via GitHub)" <gi...@apache.org> on 2025/06/17 15:20:06 UTC
[PR] refactor: rename docker-compose files and update references [superset]
polRk opened a new pull request, #33790:
URL: https://github.com/apache/superset/pull/33790
<!---
Please write the PR title following the conventions at https://www.conventionalcommits.org/en/v1.0.0/
Example:
fix(dashboard): load charts correctly
-->
### SUMMARY
<!--- Describe the change below, including rationale and design decisions -->
This pull request updates references to Docker Compose configuration files across multiple workflows, documentation, and scripts. The changes standardize the naming of these files from `docker-compose*.yml` to `compose*.yml` for consistency.
### ADDITIONAL INFORMATION
https://github.com/compose-spec/compose-spec/blob/main/spec.md
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2981019358
Oh that makes more sense. What are the alternatives? Any pointers to the latest/greatest packages? Articles to point to about their advantages over `docker compose` ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2997784188
So I'd say two options:
- revert until we have versioned docs in place
- clarify the docs with "prior to version N do this, post version N do this"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2994414519
Oh right, the real longer term solution is to publish the versioned docs. I know @rusackas was working on that a little while back.
In the meantime, it'd be great if someone could add a note about this. Here it changes depending on what version you have checked out.
Could also revert...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch merged PR #33790:
URL: https://github.com/apache/superset/pull/33790
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2980965456
I'm not against this renaming, though it's unclear to me if it's a net positive. Tradeoff is things are a bit more intuitive to newcomers and creating a bit of confusion for current devs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2980970523
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/33790?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
All modified and coverable lines are covered by tests :white_check_mark:
> Project coverage is 51.72%. Comparing base [(`76d897e`)](https://app.codecov.io/gh/apache/superset/commit/76d897eaa2f9e137102bc194c2e3109c29d0348f?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) to head [(`64a36e5`)](https://app.codecov.io/gh/apache/superset/commit/64a36e5651b3e891012c20ce3777d1f8c0152790?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
> Report is 1970 commits behind head on master.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #33790 +/- ##
==========================================
- Coverage 60.48% 51.72% -8.77%
==========================================
Files 1931 558 -1373
Lines 76236 40347 -35889
Branches 8568 4238 -4330
==========================================
- Hits 46114 20870 -25244
+ Misses 28017 18917 -9100
+ Partials 2105 560 -1545
```
| [Flag](https://app.codecov.io/gh/apache/superset/pull/33790/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [hive](https://app.codecov.io/gh/apache/superset/pull/33790/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `47.16% <ø> (-1.99%)` | :arrow_down: |
| [javascript](https://app.codecov.io/gh/apache/superset/pull/33790/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [presto](https://app.codecov.io/gh/apache/superset/pull/33790/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `50.93% <ø> (-2.88%)` | :arrow_down: |
| [python](https://app.codecov.io/gh/apache/superset/pull/33790/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `51.71% <ø> (-11.79%)` | :arrow_down: |
| [unit](https://app.codecov.io/gh/apache/superset/pull/33790/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `100.00% <ø> (+42.36%)` | :arrow_up: |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/superset/pull/33790?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "jbat (via GitHub)" <gi...@apache.org>.
jbat commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2993838543
This creates some confusion on the 4.1.2 official release as it appears this doc change is live already.
As per the [Quickstart](https://superset.apache.org/docs/quickstart)
```
git checkout tags/4.1.2
docker compose -f compose-image-tag.yml up
superset/compose-image-tag.yml: no such file or directory
```
4.1.2 release has the yml file still as `docker-compose-image-tag.yml`
If we are sticking with this compose-image-tag.yml filename change
we may need 2 cmds mentioned in the Quickstart for pre and post namechange
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "hainenber (via GitHub)" <gi...@apache.org>.
hainenber commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-3000886618
For now, my vote is on the revert. More folks will feel baffled reading the Quickstart guide.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2997641568
It will also appear as `docker-compose-image-tag.yml` to anyone who sets their repo to the 5.0.0 tag: https://github.com/apache/superset/blob/5.0/docs/docs/quickstart.mdx.
We could revert the renaming PR and hold it for the next major release, that way it would hit the repo right before 6.0.0 come out and be included in 6.0.0? That would minimize the amount of time there's a difference between how you run master vs. latest. Though even then we'd want a note about the file name being different for versions <=5.x
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-3000884510
I guess let's revert until we get versioned docs? New issues keep coming in about this.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "polRk (via GitHub)" <gi...@apache.org>.
polRk commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2981122442
> Oh that makes more sense. What are the alternatives? Any pointers to the latest/greatest packages? Articles to point to about their advantages over `docker compose` ?
Docker Compose indeed works well with the Compose specification and detects compose.y(a)ml files by default. However, there are other tools that also support this specification, including:
- Docker Compose
- Podman Compose
- Kompose
- Nerdctl
- Okteto Stacks
- Docker Cloud Integrations
You can find the full list and additional information on the official Compose specification page: [Compose-spec README](https://github.com/compose-spec/compose-spec/blob/main/README.md#implementations).
In my changes, I'm not suggesting replacing `docker compose ...`. All documentation remains the same and everything continues to work as before.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "rusackas (via GitHub)" <gi...@apache.org>.
rusackas commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2992455299
Nobody's chimed in. Merge?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "polRk (via GitHub)" <gi...@apache.org>.
polRk commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2980995308
> I'm not against this renaming, though it's unclear to me if it's a net positive. Tradeoff is things are a bit more intuitive to newcomers and creating a bit of confusion for current devs.
Thank you for your feedback!
The main reason for renaming docker-compose.yml to compose.yml is that there are now various solutions, beyond Docker, that support running applications based on the Compose specification. Having "docker" in the file name can mislead some developers, particularly those who don't have access to Docker, into thinking that Docker is a mandatory requirement for running applications, which is not necessarily the case.
Renaming makes the configuration more universal and accessible to a broader range of developers, regardless of the tools they are using.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "hainenber (via GitHub)" <gi...@apache.org>.
hainenber commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-3000942992
yikes, GH doesn't allow creating revert due to newly changes. Had to manually create the PR [here](https://github.com/apache/superset/pull/33883), committer folks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: rename docker-compose files and update references [superset]
Posted by "polRk (via GitHub)" <gi...@apache.org>.
polRk commented on PR #33790:
URL: https://github.com/apache/superset/pull/33790#issuecomment-2995959744
@jbat Thanks for catching this! You’re right — the filename change in the docs can be confusing for anyone following the Quickstart on the 4.1.2 release, since that version still uses docker-compose-image-tag.yml. The main branch now uses compose-image-tag.yml, so the docs and code are out of sync for older releases.
Until versioned documentation is available, I can add a note to the Quickstart to clarify which filename to use depending on the version. Would that work for you, or would you prefer to revert the doc changes for now? Happy to help either way!
Let me know which approach you prefer — I’m happy to submit a PR with the clarification!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org