diff options
| -rw-r--r-- | .github/workflows/context7-refresh.yml | 18 | ||||
| -rw-r--r-- | context7.json | 3 |
2 files changed, 12 insertions, 9 deletions
diff --git a/.github/workflows/context7-refresh.yml b/.github/workflows/context7-refresh.yml index c4c33635..2999865f 100644 --- a/.github/workflows/context7-refresh.yml +++ b/.github/workflows/context7-refresh.yml @@ -1,12 +1,13 @@ name: Context7 refresh # Refreshes the Context7 variant for the pushed branch. Context7 indexes -# three variants of this library, all tracking a branch HEAD directly: +# four variants of this library, all tracking a branch HEAD directly: # - rolling → default variant (omit both `branch` and `tag`) +# - scutum → branch variant `branch: "scutum"` (VyOS 1.6) # - circinus → branch variant `branch: "circinus"` (VyOS 1.5) # - sagitta → branch variant `branch: "sagitta"` (VyOS 1.4) # -# The circinus/sagitta variants are declared as branch entries in +# The scutum/circinus/sagitta variants are declared as branch entries in # context7.json `previousVersions`. There is no longer any git-tag # indirection — Context7 re-crawls the branch HEAD on refresh, so the # variant always reflects current branch content. @@ -16,7 +17,7 @@ name: Context7 refresh # README, etc.) never trigger a refresh — Context7 only ingests `docs/**` # (per context7.json `folders`) plus the config file itself. # -# NOTE: circinus/sagitta must be registered as BRANCH variants in the +# NOTE: scutum/circinus/sagitta must be registered as BRANCH variants in the # Context7 dashboard (driven by the context7.json `previousVersions` # branch entries on the default branch). A refresh with `branch: "<name>"` # returns 404 until Context7 has crawled the config and registered the @@ -26,6 +27,7 @@ on: push: branches: - rolling + - scutum - circinus - sagitta paths: @@ -34,9 +36,9 @@ on: workflow_dispatch: inputs: variant: - description: "Context7 variant to refresh (rolling = default; circinus = 1.5; sagitta = 1.4)" + description: "Context7 variant to refresh (rolling = default; scutum = 1.6; circinus = 1.5; sagitta = 1.4)" type: choice - options: [rolling, circinus, sagitta] + options: [rolling, scutum, circinus, sagitta] default: rolling permissions: {} @@ -75,11 +77,11 @@ jobs: # Defense-in-depth: the type:choice UI constraint is bypassable when # workflow_dispatch is invoked via API (`gh workflow run -f variant=…`). case "$VARIANT" in - rolling|circinus|sagitta) ;; - *) echo "Invalid variant: '${VARIANT}'. Expected one of: rolling, circinus, sagitta." >&2; exit 1 ;; + rolling|scutum|circinus|sagitta) ;; + *) echo "Invalid variant: '${VARIANT}'. Expected one of: rolling, scutum, circinus, sagitta." >&2; exit 1 ;; esac echo "Refreshing Context7 variant: $VARIANT" - # rolling = default variant (no field). circinus/sagitta = branch-backed. + # rolling = default variant (no field). scutum/circinus/sagitta = branch-backed. if [[ "$VARIANT" == "rolling" ]]; then PAYLOAD="$(jq -nc --arg lib "/$REPO" \ '{libraryName: $lib}')" diff --git a/context7.json b/context7.json index 7675f911..9bd98961 100644 --- a/context7.json +++ b/context7.json @@ -26,7 +26,7 @@ "Documentation sources are MyST Markdown (.md). Cite and link to the .md form.", "VyOS has two CLI modes: configuration mode (entered via `configure`; for `set`/`delete`/`commit`/`save` and config-state `show`) and operational mode (default after login; for `show`, `monitor`, plus image-mgmt like `add system image`). Do not mix.", "Configuration commands are wrapped in `cfgcmd` fenced blocks; operational commands in `opcmd` fenced blocks. Treat these as authoritative command syntax.", - "Branch-to-version mapping (cite version-appropriate docs): `rolling` = rolling / next major, 1.6+ (default); `circinus` = 1.5.x (current LTS); `sagitta` = 1.4.x (previous LTS); `equuleus` = 1.3.x (legacy); `crux` = 1.2.x (legacy).", + "Branch-to-version mapping (cite version-appropriate docs): `rolling` = rolling / next major (default); `scutum` = 1.6.x; `circinus` = 1.5.x (current LTS); `sagitta` = 1.4.x (previous LTS); `equuleus` = 1.3.x (legacy); `crux` = 1.2.x (legacy).", "Do not invent CLI commands. If a command isn't in the docs, say so rather than guess — VyOS syntax is strict and unknown commands fail validation at commit time.", "Use reserved documentation IP space in examples: 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24 (RFC 5737), 2001:db8::/32 (RFC 3849). Never use real or RFC1918 addresses.", "`commit` activates pending `set`/`delete` changes and runs validation (errors = no change applied); `save` persists across reboot. Verify with `show <node>` (config mode) or `show configuration commands` (op mode). Always include `commit` and `save`.", @@ -36,6 +36,7 @@ "Routing protocols (BGP, OSPF, IS-IS, RIP) are FRR-backed, but not every FRR knob is exposed through the VyOS CLI. Confirm a command exists in the VyOS docs before suggesting it — synthesizing from FRR documentation produces invalid VyOS commands." ], "previousVersions": [ + { "branch": "scutum" }, { "branch": "circinus" }, { "branch": "sagitta" } ] |