Skip to content

chore(board): rename $BOARD_EDITOR to $DOCKER_AGENT_BOARD_EDITOR#3514

Merged
dgageot merged 2 commits into
docker:mainfrom
dgageot:rename-board-editor-env-var
Jul 7, 2026
Merged

chore(board): rename $BOARD_EDITOR to $DOCKER_AGENT_BOARD_EDITOR#3514
dgageot merged 2 commits into
docker:mainfrom
dgageot:rename-board-editor-env-var

Conversation

@dgageot

@dgageot dgageot commented Jul 7, 2026

Copy link
Copy Markdown
Member

The board feature lets users configure a preferred editor via an environment variable, but the original name BOARD_EDITOR is too generic and doesn't follow the DOCKER_AGENT_ prefix convention used by the project's other env vars.

This renames the variable to DOCKER_AGENT_BOARD_EDITOR across the codebase and documentation. To avoid silently breaking existing setups, the old BOARD_EDITOR name is kept as a fallback for one release — both in the Go env lookup and in the tmux shell expansion (${DOCKER_AGENT_BOARD_EDITOR:-${BOARD_EDITOR:-code}}), matching the pattern already used for other renamed env vars in this project.

Users relying on BOARD_EDITOR will continue to see their editor launched without any change; they can migrate to DOCKER_AGENT_BOARD_EDITOR at their own pace before the fallback is removed.

@dgageot dgageot requested a review from a team as a code owner July 7, 2026 15:01
@aheritier aheritier added area/tui For features/issues/fixes related to the TUI kind/chore Maintenance, deps, CI, tooling (maps to chore: commit prefix) labels Jul 7, 2026

@docker-agent docker-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟢 APPROVE

This is a clean, well-structured rename of BOARD_EDITORDOCKER_AGENT_BOARD_EDITOR. The backward-compatibility fallback chain is correctly implemented in both the Go env lookup and the tmux shell expansion, and documentation is updated consistently. No bugs or regressions introduced.

@dgageot dgageot merged commit 4f42fc5 into docker:main Jul 7, 2026
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tui For features/issues/fixes related to the TUI kind/chore Maintenance, deps, CI, tooling (maps to chore: commit prefix)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants