ff-sec-actions/.github/workflows/docs.yml at 167b840db25a7c50288f5dec39090c28935491b4 · filecoin-project/ff-sec-actions · 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
name: Documentation Contract

on:
  pull_request:
    paths:
      - README.md
      - CONTEXT.md
      - docs/**
      - examples/**
      - actions/**
      - schemas/**
      - prompts/**
      - roadmap/**
      - security/**
      - threat-model/**
      - .github/workflows/**
      - scripts/check-docs.sh
      - scripts/roadmap.sh
      - scripts/test-roadmap.sh
      - scripts/check-execution-trust.sh
      - scripts/check-workflow-security.sh
      - scripts/test-workflow-security.sh
      - scripts/check-baseline-no-exec.sh
      - scripts/test-baseline-no-exec.sh
      - scripts/check-scanner-gates.sh
      - scripts/check-output-contract.sh
      - scripts/test-output-contract.sh
      - scripts/test-scanner-outcome.sh
      - scripts/check-evaluation-result.sh
      - scripts/test-evaluation-result.sh
      - scripts/test-gitleaks-scan.sh
      - scripts/test-zizmor-scan.sh
      - scripts/test-consumer-actions-security.sh
      - scripts/test-consumer-alpha.sh
      - scripts/check-release-graph.sh
      - scripts/test-release-graph.sh
      - scripts/check-fork-pr.sh
      - scripts/test-fork-pr.sh
      - test/fixtures/fork-pr/**
      - test/fixtures/evaluation-result/**
      - test/fixtures/ecosystem-baseline/**
      - test/fixtures/actions-security/**
  push:
    branches: [main]
    paths:
      - README.md
      - CONTEXT.md
      - docs/**
      - examples/**
      - actions/**
      - schemas/**
      - prompts/**
      - roadmap/**
      - security/**
      - threat-model/**
      - .github/workflows/**
      - scripts/check-docs.sh
      - scripts/roadmap.sh
      - scripts/test-roadmap.sh
      - scripts/check-execution-trust.sh
      - scripts/check-workflow-security.sh
      - scripts/test-workflow-security.sh
      - scripts/check-baseline-no-exec.sh
      - scripts/test-baseline-no-exec.sh
      - scripts/check-scanner-gates.sh
      - scripts/check-output-contract.sh
      - scripts/test-output-contract.sh
      - scripts/test-scanner-outcome.sh
      - scripts/check-evaluation-result.sh
      - scripts/test-evaluation-result.sh
      - scripts/test-gitleaks-scan.sh
      - scripts/test-zizmor-scan.sh
      - scripts/test-consumer-actions-security.sh
      - scripts/test-consumer-alpha.sh
      - scripts/check-release-graph.sh
      - scripts/test-release-graph.sh
      - scripts/check-fork-pr.sh
      - scripts/test-fork-pr.sh
      - test/fixtures/fork-pr/**
      - test/fixtures/evaluation-result/**
      - test/fixtures/ecosystem-baseline/**
      - test/fixtures/actions-security/**
  workflow_dispatch:

permissions:
  contents: read

jobs:
  documentation-contract:
    name: Documentation Contract
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout documentation and examples
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          fetch-depth: 0
          persist-credentials: false

      - name: Validate documentation navigation and local links
        run: bash scripts/check-docs.sh

      - name: Test machine-readable roadmap state
        run: bash scripts/test-roadmap.sh

      - name: Validate execution-trust classification
        run: bash scripts/check-execution-trust.sh

      - name: Validate workflow authority and checkout
        run: bash scripts/check-workflow-security.sh

      - name: Test workflow-security contract
        run: bash scripts/test-workflow-security.sh

      - name: Validate non-executing baseline workflows
        run: bash scripts/check-baseline-no-exec.sh

      - name: Test malicious lifecycle-hook fixture
        run: bash scripts/test-baseline-no-exec.sh

      - name: Validate scanner gate forwarding
        run: bash scripts/check-scanner-gates.sh

      - name: Validate consumable evaluation outputs
        run: |
          bash scripts/check-output-contract.sh
          bash scripts/test-output-contract.sh

      - name: Test scanner outcome semantics
        run: bash scripts/test-scanner-outcome.sh

      - name: Test Evaluation Result completion semantics
        run: bash scripts/test-evaluation-result.sh

      - name: Test generic evaluation adapter lifecycle
        run: bash scripts/test-evaluation-adapter.sh

      - name: Test Evidence Bundle aggregation
        run: bash scripts/test-aggregate-results.sh

      - name: Validate Ecosystem Baseline composition and planted fixtures
        run: bash scripts/test-ecosystem-baseline.sh

      - name: Test secretless fork and history scanning
        run: bash scripts/test-gitleaks-scan.sh

      - name: Test consumer GitHub Actions security evaluation
        run: bash scripts/test-consumer-actions-security.sh

      - name: Test consumer alpha installation contract
        run: bash scripts/test-consumer-alpha.sh

      - name: Validate immutable consumer release graph
        run: bash scripts/check-release-graph.sh

      - name: Test release graph rejection behavior
        run: bash scripts/test-release-graph.sh

      - name: Validate fork pull-request boundaries
        run: bash scripts/check-fork-pr.sh

      - name: Test fork boundary rejection behavior
        run: bash scripts/test-fork-pr.sh

      - name: Validate shell scripts
        run: shellcheck scripts/*.sh actions/*/*.sh actions/*/scripts/*.sh

      - name: Validate workflow and example syntax
        # actionlint v1.7.12, pinned to the release commit.
        run: go run github.com/rhysd/actionlint/cmd/actionlint@914e7df21a07ef503a81201c76d2b11c789d3fca .github/workflows/*.yml examples/*.yml test/fixtures/fork-pr/workflow.yml