GeezerVison is showing github.com — Fix documentation examples and workflow notes to match implementation… · bQuery/bQuery@013bec3
File tree
Expand file treeCollapse file tree
Open diff view settings
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss bannerExpand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboard +48Lines changed: 48 additions & 0 deletions | Original file line number | Diff line number | Diff line change |
|---|
|
| 1 | +name: Docs link check |
| 2 | + |
| 3 | +permissions: |
| 4 | + contents: read |
| 5 | + |
| 6 | +on: |
| 7 | + push: |
| 8 | + branches: |
| 9 | + - main |
| 10 | + - development |
| 11 | + paths: |
| 12 | + - 'docs/**' |
| 13 | + - '.github/workflows/docs-link-check.yml' |
| 14 | + - 'lychee.toml' |
| 15 | + pull_request: |
| 16 | + branches: |
| 17 | + - main |
| 18 | + - development |
| 19 | + paths: |
| 20 | + - 'docs/**' |
| 21 | + - '.github/workflows/docs-link-check.yml' |
| 22 | + - 'lychee.toml' |
| 23 | + schedule: |
| 24 | + # Weekly check of external links — Monday 06:00 UTC. |
| 25 | + - cron: '0 6 * * 1' |
| 26 | + |
| 27 | +jobs: |
| 28 | + link-check: |
| 29 | + name: Lychee |
| 30 | + runs-on: ubuntu-latest |
| 31 | + permissions: |
| 32 | + contents: read |
| 33 | + issues: write |
| 34 | + |
| 35 | + steps: |
| 36 | + - name: Checkout repository |
| 37 | + uses: actions/checkout@v6 |
| 38 | + |
| 39 | + - name: Run lychee |
| 40 | + id: lychee |
| 41 | + uses: lycheeverse/lychee-action@v2 |
| 42 | + with: |
| 43 | + args: --config lychee.toml --no-progress 'docs/**/*.md' |
| 44 | + # Report broken links without failing the workflow (`fail: false`). |
| 45 | + # `docs:check` separately audits whether exported APIs are mentioned |
| 46 | + # in the docs corpus. |
| 47 | + fail: false |
| 48 | + jobSummary: true |
Collapse file
Copy file name to clipboard +58Lines changed: 58 additions & 0 deletions | Original file line number | Diff line number | Diff line change |
|---|
|
| 1 | +name: Docs |
| 2 | + |
| 3 | +permissions: |
| 4 | + contents: read |
| 5 | + |
| 6 | +on: |
| 7 | + push: |
| 8 | + branches: |
| 9 | + - main |
| 10 | + - development |
| 11 | + paths: |
| 12 | + - 'docs/**' |
| 13 | + - 'src/**' |
| 14 | + - 'package.json' |
| 15 | + - 'CHANGELOG.md' |
| 16 | + - 'README.md' |
| 17 | + - '.github/workflows/docs.yml' |
| 18 | + pull_request: |
| 19 | + branches: |
| 20 | + - main |
| 21 | + - development |
| 22 | + paths: |
| 23 | + - 'docs/**' |
| 24 | + - 'src/**' |
| 25 | + - 'package.json' |
| 26 | + - 'CHANGELOG.md' |
| 27 | + - 'README.md' |
| 28 | + - '.github/workflows/docs.yml' |
| 29 | + |
| 30 | +jobs: |
| 31 | + build: |
| 32 | + name: Build VitePress site |
| 33 | + runs-on: ubuntu-latest |
| 34 | + permissions: |
| 35 | + contents: read |
| 36 | + |
| 37 | + steps: |
| 38 | + - name: Checkout repository |
| 39 | + uses: actions/checkout@v6 |
| 40 | + |
| 41 | + - name: Setup Bun |
| 42 | + uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2.0.2 |
| 43 | + with: |
| 44 | + bun-version: '1.3.13' |
| 45 | + |
| 46 | + - name: Install dependencies |
| 47 | + run: bun install --frozen-lockfile |
| 48 | + |
| 49 | + - name: Build docs |
| 50 | + run: bun run docs:build |
| 51 | + |
| 52 | + - name: Upload built site (artifact) |
| 53 | + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} |
| 54 | + uses: actions/upload-artifact@v4 |
| 55 | + with: |
| 56 | + name: docs-dist |
| 57 | + path: docs/.vitepress/dist |
| 58 | + retention-days: 7 |
Collapse file
Copy file name to clipboardExpand all lines: .gitignore +4Lines changed: 4 additions & 0 deletions | Original file line number | Diff line number | Diff line change |
|---|
|
59 | 59 | .npm/ |
60 | 60 | */.vitepress/cache/ |
61 | 61 | package-lock.json |
| 62 | + |
| 63 | +# Generated documentation outputs |
| 64 | +docs/api/ |
| 65 | +docs/.vitepress/dist/ |