Skip to content

docs(hub): document cscli.hub_branch for pinning to a pre-merge hub branch - #21

Open
sabban wants to merge 1 commit into
mainfrom
hub-branch-pinning
Open

docs(hub): document cscli.hub_branch for pinning to a pre-merge hub branch#21
sabban wants to merge 1 commit into
mainfrom
hub-branch-pinning

Conversation

@sabban

@sabban sabban commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Documents cscli.hub_branch in references/configure/hub.md: what it does, how to set/show it (cscli hub branch), and that Docker has no dedicated env var for it.
  • Documents two gotchas reproduced hands-on against a real in-progress hub PR ([do-not-merge] Waf Challenge Collection hub#1826, test-waf-challenge-mode-scenarios):
    • reverting hub_branch can leave other collections tainted if the test branch bumped a shared dependency (e.g. a parser) past what the current index ships
    • items that only ever existed on the test branch can't be cscli <type> removed afterward (cscli no longer resolves the name) — the leftover files must be deleted directly
  • Adds a router entry in SKILL.md and a one-line cscli hub branch cheat-sheet entry.

Verification

Ran the full flow against the crowdsec:dev docker deployment (1.7.5-174-g66ab61fc-dirty): set hub_branch, hub update, confirmed the real crowdsecurity/appsec-bot-challenge collection (unreleased, PR #1826) became installable, installed it, reverted, reproduced the taint, fixed it with --force, then cleaned up the orphaned items. verified: frontmatter entry added (env: docker, 2026-07-17).

check-verification.py and claude plugin validate . both pass.

Test plan

  • python3 skills/crowdsec/scripts/check-verification.py — new entry parses, 0d age
  • claude plugin validate . — passes
  • Manual walkthrough of every command in the new section against a live docker crowdsec install

Covers setting/showing hub_branch, the docker gotcha (no env-var
equivalent), and two gotchas reproduced hands-on against a real
in-progress hub PR: reverting taints collections that shared a
now-bumped dependency, and items unique to the test branch can't be
`cscli remove`d afterward (must delete the leftover files directly).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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