Skip to content

docs(local-dev): fix stale comment claiming infra is unmanaged#6025

Merged
Yicong-Huang merged 1 commit into
apache:mainfrom
Yicong-Huang:docs/local-dev-infra-comment
Jun 30, 2026
Merged

docs(local-dev): fix stale comment claiming infra is unmanaged#6025
Yicong-Huang merged 1 commit into
apache:mainfrom
Yicong-Huang:docs/local-dev-infra-comment

Conversation

@Yicong-Huang

@Yicong-Huang Yicong-Huang commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

What changes were proposed in this PR?

The usage banner in bin/local-dev/main.sh claimed Docker infra is not
managed by the script and that you must bring it up yourself before up. That
contradicts the actual code: cmd_up calls infra_up (which runs docker compose up -d against project texera-local-dev) and cmd_down calls
infra_down for any docker targets.

Before:  comment says "infra is NOT managed here -- bring those up yourself"
After:   comment says "infra IS managed: `up` brings it up, `down` tears it down"

Comment-only change; no behavior change.

Any related issues, documentation, discussions?

Related to #5960 (introduced bin/local-dev and this banner) and #6007 (wired
infra_up into up/auto, which is what made the banner stale). No dedicated
issue — documentation/comment-only fix (issue-first is excepted for docs). The
sibling bin/local-dev/README.md already documents the correct behavior
("infra in docker, JVM + frontend native"); this just realigns the script's
own banner.

How was this PR tested?

No tests — comment-only change. Verified the described behavior by reading
cmd_upinfra_up (docker compose up -d, project texera-local-dev) and
cmd_downinfra_down, and by running bin/local-dev.sh up, which brought
up postgres/minio/lakefs/lakekeeper/litellm automatically (14/14 services
healthy) with no manual docker compose step.

Was this PR authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.8)

@github-actions

Copy link
Copy Markdown
Contributor

Automated Reviewer Suggestions

Based on the git blame history of the changed files, we recommend the following reviewers:

  • No candidates found from git blame history.

@Yicong-Huang Yicong-Huang requested a review from bobbai00 June 29, 2026 06:18
@Yicong-Huang Yicong-Huang added this pull request to the merge queue Jun 29, 2026
Merged via the queue into apache:main with commit 2c2b76b Jun 30, 2026
23 checks passed
@Yicong-Huang Yicong-Huang deleted the docs/local-dev-infra-comment branch June 30, 2026 00:06
Mrudhulraj pushed a commit to Mrudhulraj/texera that referenced this pull request Jun 30, 2026
…e#6025)

### What changes were proposed in this PR?

The usage banner in `bin/local-dev/main.sh` claimed Docker infra is
**not**
managed by the script and that you must bring it up yourself before
`up`. That
contradicts the actual code: `cmd_up` calls `infra_up` (which runs
`docker
compose up -d` against project `texera-local-dev`) and `cmd_down` calls
`infra_down` for any docker targets.

```
Before:  comment says "infra is NOT managed here -- bring those up yourself"
After:   comment says "infra IS managed: `up` brings it up, `down` tears it down"
```

Comment-only change; no behavior change.

### Any related issues, documentation, discussions?

Related to apache#5960 (introduced `bin/local-dev` and this banner) and apache#6007
(wired
`infra_up` into `up`/`auto`, which is what made the banner stale). No
dedicated
issue — documentation/comment-only fix (issue-first is excepted for
docs). The
sibling `bin/local-dev/README.md` already documents the correct behavior
("infra in docker, JVM + frontend native"); this just realigns the
script's
own banner.

### How was this PR tested?

No tests — comment-only change. Verified the described behavior by
reading
`cmd_up` → `infra_up` (`docker compose up -d`, project
`texera-local-dev`) and
`cmd_down` → `infra_down`, and by running `bin/local-dev.sh up`, which
brought
up postgres/minio/lakefs/lakekeeper/litellm automatically (14/14
services
healthy) with no manual `docker compose` step.

### Was this PR authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.8)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants