claude-memory-files/.github/workflows/docs.yml at main · riboseinc/claude-memory-files · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
name: Build and deploy docs site

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
  pull_request:
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  # PR validation: build the site to confirm it compiles, but don't deploy.
  # Runs only on pull_request events.
  validate-docs:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.3'
          bundler-cache: true
          working-directory: docs
      - name: Build with Jekyll (validation only, no deploy)
        # Production baseurl is kept so canonical URLs in rendered HTML
        # match the live site at riboseinc.github.io/claude-memory-files/.
        # Output is written into _lychee_site/claude-memory-files/ so the
        # filesystem layout mirrors the URL structure — root-relative
        # links like /claude-memory-files/concepts/foo/ then resolve
        # against root-dir = docs/_lychee_site without lychee remap.
        run: bundle exec jekyll build --strict_front_matter --trace --destination _lychee_site/claude-memory-files
        working-directory: docs
        env:
          JEKYLL_ENV: production

      - name: Check links with lychee
        uses: lycheeverse/lychee-action@v2
        with:
          args: --config lychee.toml --root-dir "${{ github.workspace }}/docs/_lychee_site" './docs/_lychee_site/**/*.html'
          fail: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  # Production build for deploy. Runs only on push to main / workflow_dispatch.
  build:
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.3'
          bundler-cache: true
          working-directory: docs
      - name: Build with Jekyll
        run: bundle exec jekyll build --verbose --trace --baseurl "${{ steps.pages.outputs.base_path }}"
        working-directory: docs
        env:
          JEKYLL_ENV: production
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_site

  deploy:
    needs: build
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4