ferrflow 7.21.0

Universal semantic versioning for monorepos and classic repos
Documentation 
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

name: Site docs

# ci.yml ignores docs/site on push so a documentation change cannot reach the
# release job. That leaves these pages unchecked on main, so they get their own
# workflow. It stays cheap on purpose: no Rust, no fixtures, so a typo fix does
# not queue behind the full suite.
on:
  push:
    branches: [main]
    paths: ['docs/site/**', 'scripts/validate-site-docs.mjs', '.github/workflows/site-docs.yml']
  pull_request:
    branches: [main]
    paths: ['docs/site/**', 'scripts/validate-site-docs.mjs', '.github/workflows/site-docs.yml']

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions:
  contents: read

jobs:
  validate:
    name: Validate page frontmatter
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          fetch-depth: 0
          persist-credentials: false
      - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7
        with:
          node-version: '24'
      - name: Validate docs/site/**/*.md frontmatter
        run: node scripts/validate-site-docs.mjs
      # A frozen snapshot records what a past major actually documented, mistakes
      # included, because someone pinned to that major reads it to understand the
      # binary they are running. Adding a whole new one is how a version gets
      # frozen, so only edits and deletions inside an existing one are rejected.
      - name: Reject edits to a frozen snapshot
        if: github.event_name == 'pull_request'
        env:
          BASE: ${{ github.event.pull_request.base.sha }}
        run: |
          edited=$(git diff --diff-filter=MD --name-only "$BASE...HEAD" -- 'docs/site/docs-v*' 'docs/site/docs-fr-v*')
          if [ -n "$edited" ]; then
            echo "These pages belong to a frozen version and must not be changed or removed:"
            echo "$edited" | sed 's/^/  /'
            echo
            echo "Fix the current docs under docs/site/docs-en/ or docs/site/docs-fr/ instead."
            exit 1
          fi
          echo "No frozen snapshot touched."