Skip to content

feat(spec render): Add supporting infrastructure for rendered specs#16674

Merged
christopherco merged 3 commits intomicrosoft:tomls/base/mainfrom
dmcilvaney:damcilva/4.0/add_render_pipeline
Apr 25, 2026
Merged

feat(spec render): Add supporting infrastructure for rendered specs#16674
christopherco merged 3 commits intomicrosoft:tomls/base/mainfrom
dmcilvaney:damcilva/4.0/add_render_pipeline

Conversation

@dmcilvaney
Copy link
Copy Markdown
Contributor

@dmcilvaney dmcilvaney commented Apr 14, 2026

  • CI pipeline that validates the state of the files
  • Update agent instructions to understand rendered files
  • Add instructions about writing workflows

@dmcilvaney dmcilvaney force-pushed the damcilva/4.0/add_render_pipeline branch 2 times, most recently from 597debd to 01977e4 Compare April 15, 2026 03:11
@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines:
3 pipeline(s) were filtered out due to trigger conditions.

2 similar comments
@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines:
3 pipeline(s) were filtered out due to trigger conditions.

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines:
3 pipeline(s) were filtered out due to trigger conditions.

@dmcilvaney dmcilvaney force-pushed the damcilva/4.0/add_render_pipeline branch 5 times, most recently from 705d31a to b404f99 Compare April 17, 2026 05:49
@dmcilvaney dmcilvaney marked this pull request as ready for review April 17, 2026 17:42
Copilot AI review requested due to automatic review settings April 17, 2026 17:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds first-class “rendered specs” support to the repo by defining a canonical rendered output directory, documenting how developers should use it, and introducing CI infrastructure to detect rendered-spec drift and comment on PRs.

Changes:

  • Add rendered-specs-dir to the base project config and document specs/ as the rendered-specs location.
  • Introduce fork-PR-safe CI workflows + container tooling to render specs, detect drift, and post/update a PR comment (with patch artifact).
  • Update agent skills/prompts/instructions to prefer comp render as the fast verification loop for overlays.

Reviewed changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
base/project.toml Adds rendered-specs-dir pointing rendered output to repo-root specs/.
README.md Documents specs/ and basic “install azldev / render specs” workflow; fixes list formatting.
AGENTS.md Updates verification guidance to prefer render over prep-sources for overlay iteration.
.gitignore Ignores .hyenas/ directory.
.github/workflows/scripts/post_render_comment.py Posts/updates/deletes a PR comment summarizing rendered-spec drift; includes size/path safety mechanisms.
.github/workflows/scripts/check_rendered_specs.py Detects drift between committed vs rendered specs, filters timestamp noise, emits JSON report and optional patch.
.github/workflows/containers/azldev-runner.Dockerfile Minimal container image for running azldev workflows (git/mock/python/sudo).
.github/workflows/check-rendered-specs.yml Reusable workflow to render specs in a container, compute drift, upload artifacts, and post PR comments.
.github/workflows/check-rendered-specs-stub.yml pull_request_target stub delegating to the reusable workflow for fork safety.
.github/skills/skill-fix-overlay/SKILL.md Updates overlay-debug workflow to use render first, prep-sources for deep diffing.
.github/skills/skill-build-component/SKILL.md Updates inner loop and debugging steps to prefer render for fast verification.
.github/skills/skill-add-component/SKILL.md Adds render-based validation guidance for new components/overlays.
.github/prompts/azl-update-component.prompt.md Adds comp render to overlay verification steps.
.github/prompts/azl-debug-component.prompt.md Adds comp render as first step to classify overlay-related failures.
.github/prompts/azl-add-component.prompt.md Updates validation guidance to render + inspect specs/.
.github/instructions/spec.instructions.md Narrows hand-maintained spec instructions to base/**/*.spec (excludes rendered specs).
.github/instructions/rendered-specs.instructions.md New instructions for specs/**/* emphasizing generated/read-only nature.
.github/instructions/pr-check-workflows.instructions.md New workflow security guidelines (stub+reusable pattern, container isolation, comment hardening).
.github/copilot-instructions.md Documents specs/ layout and adds render commands to quick reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/check-rendered-specs-stub.yml
Comment thread .github/skills/skill-build-component/SKILL.md
Comment thread .github/workflows/scripts/check_rendered_specs.py
Comment thread .github/workflows/scripts/check_rendered_specs.py
Comment thread .github/workflows/scripts/post_render_comment.py
Comment thread .github/workflows/scripts/post_render_comment.py
Comment thread .github/workflows/check-rendered-specs.yml Outdated
Comment thread .github/workflows/check-rendered-specs.yml
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 18 out of 19 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/scripts/check_rendered_specs.py
Comment thread README.md Outdated
Comment thread .github/workflows/scripts/post_render_comment.py Outdated
@dmcilvaney dmcilvaney force-pushed the damcilva/4.0/add_render_pipeline branch from 9c9df22 to eee2a95 Compare April 17, 2026 20:57
Comment thread base/project.toml
Comment thread AGENTS.md
Comment thread .github/prompts/azl-add-component.prompt.md Outdated
Comment thread .github/prompts/azl-update-component.prompt.md Outdated
Comment thread .github/instructions/rendered-specs.instructions.md Outdated
Comment thread .github/instructions/pr-check-workflows.instructions.md Outdated
@dmcilvaney dmcilvaney force-pushed the damcilva/4.0/add_render_pipeline branch 2 times, most recently from 806114b to 64b62b1 Compare April 20, 2026 17:12
Comment thread .github/workflows/containers/azldev-runner.Dockerfile Outdated
Comment thread .github/workflows/check-rendered-specs-stub.yml
Comment thread .github/workflows/check-rendered-specs-stub.yml
Comment thread .github/workflows/check-rendered-specs.yml Outdated
Comment thread .github/workflows/check-rendered-specs.yml
Comment thread .github/workflows/check-rendered-specs.yml
Comment thread .github/workflows/scripts/post_render_comment.py
Comment thread .github/workflows/scripts/post_render_comment.py Outdated
Comment thread .github/workflows/scripts/post_render_comment.py
Comment thread .github/workflows/scripts/post_render_comment.py Outdated
Comment thread .github/workflows/scripts/post_render_comment.py Outdated
Comment thread .github/workflows/scripts/post_render_comment.py Outdated
Comment thread .github/workflows/scripts/post_render_comment.py
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/workflows/scripts/check_rendered_specs.py Outdated
Comment thread .github/workflows/scripts/check_rendered_specs.py Outdated
Comment thread .github/workflows/scripts/check_rendered_specs.py
Comment thread .github/workflows/scripts/check_rendered_specs.py Outdated
Comment thread .github/workflows/scripts/check_rendered_specs.py Outdated
@dmcilvaney dmcilvaney force-pushed the damcilva/4.0/add_render_pipeline branch from 5a140fb to c064a4b Compare April 25, 2026 03:45
Copy link
Copy Markdown
Collaborator

@christopherco christopherco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@christopherco christopherco merged commit d33aad4 into microsoft:tomls/base/main Apr 25, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants