docs: add cwctl specific-version upgrade instructions and iterative upgrade note#562
docs: add cwctl specific-version upgrade instructions and iterative upgrade note#562sojan-official wants to merge 1 commit intomainfrom
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 959093bb73
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ``` | ||
|
|
||
| <Note> | ||
| `-u`/`--upgrade` upgrades to latest stable (`master`), while `-U`/`--Upgrade` upgrades to a specific git ref and is currently experimental. Upgrades can fail when your Chatwoot repo has local code changes, so keep production changes clean and take backups before upgrading. Under the hood, `-U` performs a `git checkout <VERSION>` followed by `git pull`. |
There was a problem hiding this comment.
git pull after checking out a version tag
The new guidance says -U performs git checkout <VERSION> followed by git pull, and the example uses v4.3.0 (a release tag). When <VERSION> is a tag, checkout puts the repo in detached HEAD, where git pull fails with You are not currently on a branch ... git pull <remote> <branch>, so users following this documented path can hit an upgrade failure in production unless they pass a tracked branch name instead of a version tag.
Useful? React with 👍 / 👎.
1 participant
Motivation
cwctlto upgrade to a specific Chatwoot git ref to make targeted upgrades easier and safer.Description
self-hosted/deployment/chatwoot-ctl.mdxshowingsudo cwctl -U <VERSION>with an example (sudo cwctl -U v4.3.0).-u/--upgrade(latest stable) and-U/--Upgrade(specific git ref), noted that-Uis experimental, and documented that it performsgit checkout <VERSION>followed bygit pullunder the hood inself-hosted/deployment/chatwoot-ctl.mdx.self-hosted/deployment/upgrade.mdxrecommending iterative upgrades across intermediate versions (e.g., avoid upgrading directly fromv4.1tov4.10).Testing
git diff --checkto ensure no whitespace/patch issues and it passed.git status --shortwhich showed the two intended modified files and no unexpected changes.Codex Task