From: Simon Glass <simon.glass@canonical.com> Add a workflow section at the top of the README explaining the typical usage pattern for pickman: setup with add-source, cherry-pick with apply -p, review/merge, update with commit-source, and repeat. Also mention the step and review commands for automated workflows. Co-developed-by: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Simon Glass <simon.glass@canonical.com> --- tools/pickman/README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/tools/pickman/README.rst b/tools/pickman/README.rst index 0d2c55e762a..7a33378a32b 100644 --- a/tools/pickman/README.rst +++ b/tools/pickman/README.rst @@ -8,6 +8,27 @@ Pickman - Cherry-pick Manager Pickman is a tool to help manage cherry-picking commits between branches. +Workflow +-------- + +The typical workflow for using pickman is: + +1. **Setup**: Add a source branch to track with ``add-source``. This records the + starting point (merge-base) for cherry-picking. + +2. **Cherry-pick**: Run ``apply -p`` to cherry-pick the next set of commits (up + to the next merge commit) and create a GitLab MR. A Claude agent handles the + cherry-picks automatically, resolving simple conflicts. + +3. **Review**: Once the MR is reviewed and merged, run ``commit-source`` to + update the database with the last processed commit. + +4. **Repeat**: Go back to step 2 until all commits are cherry-picked. + +For automated workflows, use ``step`` instead of ``apply -p``. It checks for +open pickman MRs first and only creates a new one if none are pending. Use +``review`` to have the agent address MR comments. + Usage ----- -- 2.43.0