Repository navigation
docs(helm): sync chart values reference from released chart (DEP-370) #1244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0d1c203
feat(helm): sync the generated chart values reference on each chart r…
pmdroid 2692861
🤖 Regenerate LLMs.txt
github-actions[bot] bd836de
Merge remote-tracking branch 'origin/main' into pascal/dep-370-docs-h…
pmdroid 3a1d73d
fix(llmstxt): include uncommitted and untracked pages when detecting …
pmdroid 9fb2457
🤖 Regenerate LLMs.txt
github-actions[bot] e2edaaf
docs(helm): seed values reference from released chart 1.11.2
pmdroid 81565aa
fix(llmstxt): keep working-tree changes when previous SHA is unreachable
pmdroid File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| name: Sync Helm chart docs | ||
| # Description: Sync the generated Helm values reference for a released chart version. | ||
| # Flow: | ||
| # 1) Pull the published chart from the public OCI registry | ||
| # 2) Extract the values reference and example overlays into the docs | ||
| # 3) Regenerate public/llms.txt so the automation PR is self-contained | ||
| # 4) Open a PR for that chart version | ||
| # | ||
| # Opens the PR with GITHUB_TOKEN. That does not start other workflows, so this | ||
| # job generates llms.txt here instead of depending on llmstxt.yml to fire. | ||
|
|
||
| on: | ||
| repository_dispatch: | ||
| types: [helm_chart_published] | ||
| workflow_dispatch: | ||
| inputs: | ||
| version: | ||
| description: "Exact Arcade Helm chart version to sync (for example 1.12.0)" | ||
| required: true | ||
| type: string | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| concurrency: | ||
| group: sync-helm-chart-docs-${{ github.event.client_payload.version || inputs.version }} | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| sync: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true" | ||
| VERSION: ${{ github.event.client_payload.version || inputs.version }} | ||
| CHART_REF: oci://public.ecr.aws/s5i6x9d1/charts/arcade | ||
|
|
||
| steps: | ||
| - name: Validate version | ||
| run: | | ||
| if ! [[ "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then | ||
| echo "::error::Invalid version: $VERSION" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install pnpm | ||
| uses: pnpm/action-setup@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "22" | ||
| cache: pnpm | ||
|
|
||
| - name: Install dependencies | ||
| run: pnpm install --frozen-lockfile | ||
|
|
||
| - name: Install Helm | ||
| uses: azure/setup-helm@v4 | ||
|
|
||
| # The monorepo dispatches this workflow right after it pushes the chart, | ||
| # but the registry can take a few minutes to serve the new version. | ||
| - name: Pull chart | ||
| run: | | ||
| for attempt in $(seq 1 10); do | ||
| if helm pull "$CHART_REF" --version "$VERSION" --untar --untardir "$RUNNER_TEMP/chart"; then | ||
| echo "Pulled chart $VERSION" | ||
| exit 0 | ||
| fi | ||
| echo "Attempt $attempt: chart $VERSION not available yet, retrying in 30s" | ||
| sleep 30 | ||
| done | ||
| echo "::error::Chart $VERSION did not become available within 5 minutes" | ||
| exit 1 | ||
|
|
||
| - name: Sync values reference and examples | ||
| run: pnpm exec tsx scripts/sync-helm-chart-docs.ts --chart-dir "$RUNNER_TEMP/chart/arcade" --version "$VERSION" | ||
|
|
||
| # GITHUB_TOKEN PRs do not start llmstxt.yml, so generate the file here. | ||
| - name: Generate llms.txt | ||
| run: pnpm llmstxt | ||
| env: | ||
| ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }} | ||
|
|
||
| - name: Create pull request | ||
| id: cpr | ||
| uses: peter-evans/create-pull-request@v7 | ||
| env: | ||
| HUSKY: 0 | ||
| with: | ||
| token: ${{ github.token }} | ||
| commit-message: "[AUTO] Helm chart ${{ env.VERSION }} values reference" | ||
| title: "[AUTO] Helm chart ${{ env.VERSION }} values reference" | ||
| body: | | ||
| This PR syncs the generated values reference for Arcade Helm chart `${{ env.VERSION }}`. | ||
|
|
||
| - Chart version: `${{ env.VERSION }}` | ||
| - Trigger: `${{ github.event_name }}` | ||
| - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} | ||
| branch: automation/helm-chart-docs-${{ env.VERSION }} | ||
| delete-branch: true | ||
|
|
||
| - name: Request team review | ||
| if: steps.cpr.outputs.pull-request-number != '' | ||
| continue-on-error: true | ||
| run: gh pr edit "$PR_NUMBER" --add-reviewer ArcadeAI/engineering-tools-and-dx | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| PR_NUMBER: ${{ steps.cpr.outputs.pull-request-number }} | ||
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import type { MetaRecord } from "nextra"; | ||
|
|
||
| export const meta: MetaRecord = { | ||
| "values-reference": { | ||
| title: "Values reference", | ||
| }, | ||
| }; | ||
|
|
||
| export default meta; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.