Skip to content

chore(examples): honor DEACON_BIN and ignore generated runtime artifacts #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pofallon merged 2 commits into from
Jun 8, 2026
Merged

chore(examples): honor DEACON_BIN and ignore generated runtime artifacts #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee915d0
chore(examples): honor DEACON_BIN in read-configuration scripts
claude Jun 6, 2026
66b06cc
chore(examples): ignore devcontainer runtime artifacts tree-wide
claude Jun 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ artifacts/nextest/full-timing.json
/.devcontainer-state
/.deacon

# DevContainer runtime artifacts generated by running examples / deacon
# (lifecycle state + build cache written into the workspace folder)
**/.devcontainer-state/
**/.devcontainer/build-cache/

# Beads / Dolt files (added by bd init)
.dolt/
*.db
Expand Down
3 changes: 2 additions & 1 deletion examples/read-configuration/basic/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== Basic read-configuration (README: Run) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
3 changes: 2 additions & 1 deletion examples/read-configuration/compose/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== Compose configuration (README: Run) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
5 changes: 3 additions & 2 deletions examples/read-configuration/extends-chain/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ set -euo pipefail

ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
LEAF_DIR="${ROOT_DIR}/leaf"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== Extends chain via workspace-folder discovery (README: leaf directory) ==" >&2
(cd "$LEAF_DIR" && cargo run -p deacon -- read-configuration --workspace-folder "$(pwd)" "$@" | jq .)
(cd "$LEAF_DIR" && "$DEACON_BIN" read-configuration --workspace-folder "$(pwd)" "$@" | jq .)

echo "== Extends chain with explicit config path (README: target leaf config explicitly) ==" >&2
cargo run -p deacon -- read-configuration \
"$DEACON_BIN" read-configuration \
--workspace-folder "$LEAF_DIR" \
--config "$LEAF_DIR/.devcontainer.json" \
"$@" | jq .
5 changes: 3 additions & 2 deletions examples/read-configuration/features-additional/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== Additional feature with featuresConfiguration (README: Include featuresConfiguration) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" \
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" \
--include-features-configuration \
--additional-features '{"./extra-feature": {"flag": true}}' \
"$@" | jq .

echo "== Additional feature with mergedConfiguration (README: Optionally include mergedConfiguration) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" \
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" \
--include-merged-configuration \
--additional-features '{"./extra-feature": {}}' \
"$@" | jq .
7 changes: 4 additions & 3 deletions examples/read-configuration/features-minimal/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== Base configuration only (README: Show base configuration only) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .

echo "== Include featuresConfiguration (README: Include computed featuresConfiguration) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" \
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" \
--include-features-configuration \
"$@" | jq .

echo "== Include mergedConfiguration (README: Optionally include mergedConfiguration) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" \
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" \
--include-merged-configuration \
"$@" | jq .
3 changes: 2 additions & 1 deletion examples/read-configuration/id-labels-and-devcontainerId/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== ID labels substitution (README: Provide id-labels) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" \
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" \
--id-label com.example.project=rc-demo \
--id-label "com.example.user=$(whoami)" \
"$@" | jq .
3 changes: 2 additions & 1 deletion examples/read-configuration/legacy-normalization/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== Legacy containerEnv normalization (README: Run) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
5 changes: 3 additions & 2 deletions examples/read-configuration/override-config/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== Base only (README: Base only) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .

echo "== With override applied (README: With override applied) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" \
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" \
--override-config "$SCRIPT_DIR/override.jsonc" \
"$@" | jq .
5 changes: 3 additions & 2 deletions examples/read-configuration/with-variables/exec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
DEACON_BIN="${DEACON_BIN:-deacon}"

echo "== With variables: default env (README: Without setting env var) ==" >&2
cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
"$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .

echo "== With variables: override via MY_VAR (README: With env var influencing substitution) ==" >&2
MY_VAR=hello cargo run -p deacon -- read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
MY_VAR=hello "$DEACON_BIN" read-configuration --workspace-folder "$SCRIPT_DIR" "$@" | jq .
Loading