Commit a09b333
authored
# Pull Request
## Description
This PR migrates the planner disclaimer single-source-of-truth (SSOT)
from the standalone YAML config at `.github/config/disclaimers.yml` to a
markdown authoring contract embedded in
`.github/instructions/shared/disclaimer-language.instructions.md`. It
stacks on **#1497** (`feat/sssc-planner-rai-parity`) because removing
`disclaimers.yml` would conflict with any branch in the stack that does
not include this migration.
The instruction file now defines the disclaimer corpus as H2 sections
whose slugified headings (for example, *RAI Planning* → `rai-planner`)
are the parser-derived keys. Each section carries a CAUTION blockquote
that captures the session-start disclaimer, plus prose paragraphs joined
into a single string by the parser. A short *Authoring Contract*
preamble documents the rules so future edits stay machine-readable
without referring to the validator source.
The validator, **`scripts/linting/Validate-PlannerArtifacts.ps1`**,
swaps its YAML loader for `Import-DisclaimerSource`, which parses the
new markdown SSOT, derives planner keys from heading slugs, extracts
CAUTION blockquotes (stripping the `> [!CAUTION]` prefix), and joins
multi-line prose. The function's `-DisclaimerConfigPath` parameter is
renamed to `-DisclaimerSourcePath` to reflect the markdown origin.
A new contract suite,
**`scripts/tests/linting/Test-DisclaimerArtifacts.Tests.ps1`** (8
cases), asserts that:
* the SSOT instruction file parses into the expected planner keys with
non-empty CAUTION blockquotes and prose; and
* every planner identity file (RAI and Security) carries the required
*Session Start Display* literal and an *Exit Point Reminder* section
that references each named exit point.
To satisfy the second assertion, this PR also adds the *Disclaimer and
Attribution Protocol* section to
**`.github/instructions/security/identity.instructions.md`**, sourced
verbatim from the snapshot. The hunks in
**`scripts/tests/linting/Validate-PlannerArtifacts.Tests.ps1`** are
trimmed to disclaimer-related coverage only; the SSSC-parity hunks are
deferred to a later PR in the stack.
The three regenerated **`plugins/*/README.md`** files reflect the
disclaimer SSOT description text and are produced by `npm run
plugin:generate`.
## Related Issue(s)
Stacks on #1497. No other issue references in commits or branch name.
## Type of Change
Select all that apply:
**Code & Documentation:**
* [ ] Bug fix (non-breaking change fixing an issue)
* [ ] New feature (non-breaking change adding functionality)
* [x] Breaking change (fix or feature causing existing functionality to
change)
* [x] Documentation update
**Infrastructure & Configuration:**
* [ ] GitHub Actions workflow
* [x] Linting configuration (markdown, PowerShell, etc.)
* [ ] Security configuration
* [ ] DevContainer configuration
* [ ] Dependency update
**AI Artifacts:**
* [ ] Reviewed contribution with `prompt-builder` agent and addressed
all feedback
* [x] Copilot instructions (`.github/instructions/*.instructions.md`)
* [ ] Copilot prompt (`.github/prompts/*.prompt.md`)
* [ ] Copilot agent (`.github/agents/*.agent.md`)
* [ ] Copilot skill (`.github/skills/*/SKILL.md`)
> Note for AI Artifact Contributors:
>
> * Agents: Research, indexing/referencing other project (using standard
VS Code GitHub Copilot/MCP tools), planning, and general implementation
agents likely already exist. Review `.github/agents/` before creating
new ones.
> * Skills: Must include both bash and PowerShell scripts. See
[Skills](../docs/contributing/skills.md).
> * Model Versions: Only contributions targeting the **latest Anthropic
and OpenAI models** will be accepted. Older model versions (e.g.,
GPT-3.5, Claude 3) will be rejected.
> * See [Agents Not
Accepted](../docs/contributing/custom-agents.md#agents-not-accepted) and
[Model Version
Requirements](../docs/contributing/ai-artifacts-common.md#model-version-requirements).
**Other:**
* [x] Script/automation (`.ps1`, `.sh`, `.py`)
* [ ] Other (please describe):
## Sample Prompts (for AI Artifact Contributions)
<!-- Not applicable as a workflow trigger: the instruction file is a
passive SSOT consumed by the validator and is referenced by planner
agents at session-start. -->
For detailed contribution requirements, see:
* Common Standards:
[docs/contributing/ai-artifacts-common.md](../docs/contributing/ai-artifacts-common.md)
- Shared standards for XML blocks, markdown quality, RFC 2119,
validation, and testing
* Agents:
[docs/contributing/custom-agents.md](../docs/contributing/custom-agents.md)
- Agent configurations with tools and behavior patterns
* Prompts:
[docs/contributing/prompts.md](../docs/contributing/prompts.md) -
Workflow-specific guidance with template variables
* Instructions:
[docs/contributing/instructions.md](../docs/contributing/instructions.md)
- Technology-specific standards with glob patterns
* Skills: [docs/contributing/skills.md](../docs/contributing/skills.md)
- Task execution utilities with cross-platform scripts
## Testing
Automated validation performed by the agent:
* `npm run lint:md` — markdown linting: **Passed** (211 files, 0
errors).
* `npm run lint:frontmatter` — frontmatter validation: **Passed** (541
files, 0 errors).
* `npm run lint:ps` — PowerShell analysis: **Passed**.
* `npm run lint:yaml` — YAML validation: **Passed** (50 files).
* `npm run plugin:validate` — plugin metadata: **Passed**.
* `npm run plugin:generate` — plugin outputs regenerated and committed.
* `npm run test:ps -- -TestPath
scripts/tests/linting/Test-DisclaimerArtifacts.Tests.ps1` — **8/8
passed**.
* `npm run test:ps -- -TestPath
scripts/tests/linting/Validate-PlannerArtifacts.Tests.ps1` — **34/34
passed**.
* `grep -r "config/disclaimers" .github docs scripts collections
plugins` — **empty**, confirming no orphan references.
Security analysis findings:
* No secrets, credentials, or customer data in the diff.
* No new runtime dependencies introduced. The validator uses only
built-in PowerShell cmdlets to parse markdown.
* No changes that broaden privilege boundaries.
Diff-based assessments:
* All changed files match expected paths derived from the commit subject
and the migration scope documented in the stack plan.
* The markdown SSOT, validator, and tests follow the existing
`.github/instructions/`, `scripts/linting/`, and
`scripts/tests/linting/` conventions.
> [!NOTE]
> Manual testing was not performed.
## Checklist
### Required Checks
* [x] Documentation is updated (if applicable) — instruction file gains
an authoring contract and the SSOT corpus.
* [x] Files follow existing naming conventions.
* [x] Changes are backwards compatible (if applicable) — *(N/A — this PR
is a BREAKING change. `.github/config/disclaimers.yml` is removed;
consumers must reference `disclaimer-language.instructions.md`.
Tree-wide grep confirms zero in-codebase consumers of the deleted path;
all internal callers are updated in this PR.)*
* [x] Tests added for new functionality (if applicable).
### AI Artifact Contributions
* [ ] Used `/prompt-analyze` to review contribution
* [ ] Addressed all feedback from `prompt-builder` review
* [ ] Verified contribution follows common standards and type-specific
requirements
### Required Automated Checks
The following validation commands must pass before merging:
* [x] Markdown linting: `npm run lint:md`
* [ ] Spell checking: `npm run spell-check`
* [x] Frontmatter validation: `npm run lint:frontmatter`
* [ ] Skill structure validation: `npm run validate:skills`
* [ ] Link validation: `npm run lint:md-links`
* [x] PowerShell analysis: `npm run lint:ps`
* [x] Plugin freshness: `npm run plugin:generate`
* [ ] Docusaurus tests: `npm run docs:test`
## Security Considerations
<!-- ⚠️ WARNING: Do not commit sensitive information such as API keys,
passwords, or personal data -->
* [x] This PR does not contain any sensitive or NDA information
* [x] Any new dependencies have been reviewed for security issues —
*(N/A — no new dependencies.)*
* [x] Security-related scripts follow the principle of least privilege —
*(N/A — no security-related scripts modified.)*
## Additional Notes
This PR is the second stacked increment in the post-#1497 stack (PR C in
plan ordering). The base will switch from `feat/sssc-planner-rai-parity`
to `main` after #1497 merges. The companion PRs in the stack are:
* **PR A (#1638)** — Security Planner state schema and fixtures.
* **PR B** — Security Planner agent and phase-gate parity (depends on PR
A).
* **PR D** — Planner linter hardening (sibling off `main`).
* **PR E** — Dev environment alignment (sibling off `main`, optional).
A small *Disclaimer and Attribution Protocol* section is added to
`.github/instructions/security/identity.instructions.md` (sourced
verbatim from the snapshot) so the new contract test passes for both
planner identities. The SSSC-parity hunks in
`Validate-PlannerArtifacts.Tests.ps1` are intentionally deferred to **PR
B**, which lands them alongside the Security Planner content they
exercise.
## Merge Order
This PR is part of a stack derived from PR #1497. Required merge
sequence:
1. #1638 (PR A — `stack/security-state-schema`) — adds
`disclaimerShownAt` to canonical schemas
2. #1639 (PR C — this PR) — relocates disclaimer protocol to shared
instructions
3. #1642 (PR B — `stack/security-planner-parity`) — consumes both
#1640 and #1641 are siblings and may merge in any order independent of
this chain.
1 parent 2bdcb8d commit a09b333
8 files changed
Lines changed: 322 additions & 210 deletions
File tree
- .github
- config
- instructions
- security
- scripts
- agents/activation-harness
- linting
- tests/linting
This file was deleted.
Lines changed: 8 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
21 | 25 | | |
22 | 26 | | |
23 | 27 | | |
| |||
60 | 64 | | |
61 | 65 | | |
62 | 66 | | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
63 | 71 | | |
64 | 72 | | |
65 | 73 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
19 | 36 | | |
20 | 37 | | |
21 | 38 | | |
| |||
Lines changed: 14 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
10 | 24 | | |
11 | 25 | | |
12 | 26 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
| 20 | + | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
49 | | - | |
| 49 | + | |
50 | 50 | | |
51 | 51 | | |
52 | | - | |
| 52 | + | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
| |||
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
81 | | - | |
| 81 | + | |
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | 92 | | |
93 | | - | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| |||
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
117 | | - | |
| 117 | + | |
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
128 | | - | |
| 128 | + | |
129 | 129 | | |
130 | 130 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
14 | 15 | | |
15 | 16 | | |
16 | 17 | | |
| |||
23 | 24 | | |
24 | 25 | | |
25 | 26 | | |
26 | | - | |
27 | | - | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
28 | 30 | | |
29 | 31 | | |
30 | 32 | | |
| |||
51 | 53 | | |
52 | 54 | | |
53 | 55 | | |
54 | | - | |
| 56 | + | |
55 | 57 | | |
56 | 58 | | |
57 | 59 | | |
| |||
107 | 109 | | |
108 | 110 | | |
109 | 111 | | |
110 | | - | |
| 112 | + | |
111 | 113 | | |
112 | 114 | | |
113 | | - | |
| 115 | + | |
114 | 116 | | |
115 | | - | |
116 | | - | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
117 | 125 | | |
118 | 126 | | |
119 | | - | |
| 127 | + | |
120 | 128 | | |
121 | 129 | | |
122 | 130 | | |
123 | 131 | | |
124 | 132 | | |
125 | 133 | | |
126 | | - | |
| 134 | + | |
127 | 135 | | |
128 | 136 | | |
129 | | - | |
130 | | - | |
| 137 | + | |
| 138 | + | |
131 | 139 | | |
132 | 140 | | |
133 | | - | |
134 | | - | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
135 | 144 | | |
136 | | - | |
137 | | - | |
| 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 | + | |
| 172 | + | |
138 | 173 | | |
139 | | - | |
140 | | - | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
141 | 177 | | |
142 | 178 | | |
143 | | - | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
144 | 184 | | |
145 | 185 | | |
146 | 186 | | |
| |||
318 | 358 | | |
319 | 359 | | |
320 | 360 | | |
321 | | - | |
| 361 | + | |
322 | 362 | | |
323 | 363 | | |
324 | 364 | | |
| |||
422 | 462 | | |
423 | 463 | | |
424 | 464 | | |
425 | | - | |
426 | | - | |
| 465 | + | |
| 466 | + | |
427 | 467 | | |
428 | 468 | | |
429 | 469 | | |
| |||
447 | 487 | | |
448 | 488 | | |
449 | 489 | | |
450 | | - | |
| 490 | + | |
451 | 491 | | |
452 | 492 | | |
453 | 493 | | |
| |||
464 | 504 | | |
465 | 505 | | |
466 | 506 | | |
467 | | - | |
| 507 | + | |
468 | 508 | | |
469 | 509 | | |
470 | 510 | | |
| |||
616 | 656 | | |
617 | 657 | | |
618 | 658 | | |
619 | | - | |
| 659 | + | |
620 | 660 | | |
621 | 661 | | |
622 | 662 | | |
| |||
0 commit comments