Skip to content

docs: clarify update vs restart deploy behavior#125

Closed
benvinegar wants to merge 1 commit into
mainfrom
bentlegen/clarify-update-vs-restart
Closed

docs: clarify update vs restart deploy behavior#125
benvinegar wants to merge 1 commit into
mainfrom
bentlegen/clarify-update-vs-restart

Conversation

@benvinegar
Copy link
Copy Markdown
Member

@benvinegar benvinegar commented Feb 22, 2026

Summary

  • clarify that baudbot restart only restarts the service and does not deploy source changes
  • clarify that baudbot update includes deploy + restart in the release flow
  • add explicit guidance for local/unmerged edits: run deploy from the target checkout path
  • update CLI help text for restart and update to reflect actual behavior

Files

  • README.md
  • docs/operations.md
  • bin/baudbot

Validation

  • bash -n bin/baudbot

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Feb 22, 2026

Greptile Summary

Clarified the distinction between baudbot restart (service-only restart) and baudbot update (full release flow with deploy + restart).

Key changes:

  • Updated CLI help text to explicitly state restart does not deploy source changes
  • Added notes in documentation explaining when to use deploy.sh for local edits vs baudbot update for release-based upgrades
  • Clarified that baudbot update already includes both deployment and restart steps

The documentation now accurately reflects the actual implementation in bin/update-release.sh, which performs: preflight checks → publish release → deploy (line 363) → restart and health check (line 364).

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only changes that accurately clarify existing behavior. All changes align with the actual implementation in bin/update-release.sh and bin/baudbot. No code logic changes, no security concerns.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Added clarification that baudbot update includes deploy+restart and baudbot restart doesn't deploy source changes, plus guidance for local edits
bin/baudbot Updated CLI help text to clarify that restart doesn't deploy source changes and update includes deploy + restart
docs/operations.md Enhanced deployment section with explicit notes on deploy vs restart behavior and when to use each command

Last reviewed commit: 9f3e1a3

@benvinegar
Copy link
Copy Markdown
Member Author

Superseded by code-change PR #128, which updates restart behavior to force bridge tmux session refresh.

@benvinegar benvinegar closed this Feb 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant