diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-10 23:00:03 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-10 23:00:03 +0300 |
| commit | 63366fb369e91849858e867b1d3fd39a388873a5 (patch) | |
| tree | 5d8ea54de2dac8fe175820daa8558ed07bc56a7d /.github/workflows | |
| parent | 9399e6255eb81076f713a6f6a9073a1003dc1b78 (diff) | |
| download | vyos-documentation-63366fb369e91849858e867b1d3fd39a388873a5.tar.gz vyos-documentation-63366fb369e91849858e867b1d3fd39a388873a5.zip | |
ci: add Context7 refresh workflow
Refreshes Context7's index of the VyOS documentation library on
completion of 'Update version tags', mapping rolling/circinus/sagitta to
Context7 variants rolling/1.5/1.4 respectively.
Triggered via workflow_run because GITHUB_TOKEN-driven tag pushes from
update-version-tags.yml do not fan out to downstream workflows.
workflow_dispatch added for ad-hoc and bootstrap refreshes.
Spec: ~/.claude/specs/2026-05-10-context7-github-actions-integration-design.md
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/context7-refresh.yml | 70 | ||||
| -rw-r--r-- | .github/workflows/update-version-tags.yml | 3 |
2 files changed, 73 insertions, 0 deletions
diff --git a/.github/workflows/context7-refresh.yml b/.github/workflows/context7-refresh.yml new file mode 100644 index 00000000..5c7e2f41 --- /dev/null +++ b/.github/workflows/context7-refresh.yml @@ -0,0 +1,70 @@ +name: Context7 refresh + +# Listens for completion of "Update version tags" via workflow_run, then +# refreshes the corresponding Context7 variant. The upstream workflow is +# matched by name — DO NOT rename `Update version tags` without updating +# the `workflows:` field below. +# +# OPERATOR NOTE: do NOT use GitHub's "Re-run jobs" on `Update version tags`. +# Re-runs replay the original SHA, which would move the version tag +# BACKWARD and trigger this workflow to refresh Context7 against stale +# content. To force a Context7 refresh, use the workflow_dispatch input +# below — it calls Context7 directly without touching any tag. + +on: + workflow_run: + workflows: ["Update version tags"] + types: [completed] + workflow_dispatch: + inputs: + version: + description: "Context7 variant to refresh" + type: choice + options: [rolling, "1.5", "1.4"] + default: rolling + +permissions: {} + +concurrency: + group: >- + context7-refresh-${{ + inputs.version + || (github.event.workflow_run.head_branch == 'circinus' && '1.5') + || (github.event.workflow_run.head_branch == 'sagitta' && '1.4') + || github.event.workflow_run.head_branch + }} + cancel-in-progress: true + +jobs: + refresh: + if: >- + github.event_name == 'workflow_dispatch' || + (github.event.workflow_run.conclusion == 'success' && + contains(fromJSON('["rolling","circinus","sagitta"]'), github.event.workflow_run.head_branch)) + runs-on: ubuntu-latest + permissions: {} + steps: + - name: Refresh Context7 library + env: + CONTEXT7_API_KEY: ${{ secrets.CONTEXT7_API_KEY }} + HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }} + DISPATCH_VERSION: ${{ inputs.version }} + run: | + set -euo pipefail + if [[ "${GITHUB_EVENT_NAME}" == "workflow_dispatch" ]]; then + VARIANT="$DISPATCH_VERSION" + else + case "$HEAD_BRANCH" in + rolling) VARIANT=rolling ;; + circinus) VARIANT=1.5 ;; + sagitta) VARIANT=1.4 ;; + *) echo "Unexpected head_branch: $HEAD_BRANCH" >&2; exit 1 ;; + esac + fi + echo "Refreshing Context7 variant: $VARIANT" + curl -fsSL --retry 2 --retry-delay 10 -X POST \ + "https://context7.com/api/v1/refresh" \ + -H "Authorization: Bearer $CONTEXT7_API_KEY" \ + -H "Content-Type: application/json" \ + -d "$(jq -nc --arg lib "/${{ github.repository }}" --arg br "$VARIANT" \ + '{libraryName: $lib, branch: $br}')" diff --git a/.github/workflows/update-version-tags.yml b/.github/workflows/update-version-tags.yml index 7f179586..35a87d61 100644 --- a/.github/workflows/update-version-tags.yml +++ b/.github/workflows/update-version-tags.yml @@ -1,5 +1,8 @@ name: Update version tags +# context7-refresh.yml triggers via workflow_run on this workflow's name. +# DO NOT rename the `name:` field above without updating context7-refresh.yml. + on: push: branches: |
