Skip to content

Commit 14f24e2

Browse files
authored
Feature/183 introduce a new root level release notemd that is separate from changelogmd (#188)
* feat(#183): introduce new Copilot instructions and update agent documentation - Add repository-wide Copilot instructions for NovaModuleTools - Update agent documentation to reflect new file structure and skills - Ensure YAML frontmatter is included for valid Copilot profiles * feat(#183): introduce RELEASE_NOTE.md for public-facing changes - Added a root-level RELEASE_NOTE.md to summarize public cmdlet, CLI, configuration, and migration changes. - Updated documentation to clarify the distinction between CHANGELOG.md and RELEASE_NOTE.md. - Modified validation and publishing workflows to include RELEASE_NOTE.md.
1 parent 983f457 commit 14f24e2

33 files changed

Lines changed: 565 additions & 91 deletions

.github/agents/architect.agent.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: architect
3+
description: Designs and scopes NovaModuleTools changes through a discussion-first flow before implementation starts
4+
---
5+
16
# NovaModuleTools architect agent
27

38
## Purpose
@@ -21,19 +26,21 @@ release automation.
2126

2227
- `README.md`
2328
- `CONTRIBUTING.md`
29+
- `.github/copilot-instructions.md`
2430
- `.github/prompts/design-change.prompt.md`
25-
- `.github/instructions/*.md`
31+
- `.github/instructions/*.instructions.md`
2632
- `tests/ArchitectureGuardrails.Tests.ps1`
2733
- Relevant `src/public/` and `src/private/<domain>/` files
2834
- Relevant `.github/workflows/*.yml`
2935

3036
## Skills to use
3137

32-
- `powershell-module-development.skill.md`
33-
- `github-actions.skill.md`
34-
- `release-and-changelog.skill.md`
35-
- `codescene-quality.skill.md`
36-
- `markdown-authoring.skill.md`
38+
- `/powershell-module-development`
39+
- `/github-actions`
40+
- `/release-and-changelog`
41+
- `/codescene-quality`
42+
- `/guiding-refactoring-with-code-health`
43+
- `/markdown-authoring`
3744

3845
## Constraints
3946

.github/agents/docs-site.agent.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: docs-site
3+
description: Keeps NovaModuleTools website documentation accurate and clearly separated from cmdlet help and contributor docs
4+
---
5+
16
# NovaModuleTools docs site agent
27

38
## Purpose
@@ -23,10 +28,10 @@ cmdlet help and contributor documentation.
2328

2429
## Skills to use
2530

26-
- `docs-site-html.skill.md`
27-
- `markdown-authoring.skill.md`
28-
- `powershell-module-development.skill.md`
29-
- `release-and-changelog.skill.md`
31+
- `/docs-site-html`
32+
- `/markdown-authoring`
33+
- `/powershell-module-development`
34+
- `/release-and-changelog`
3035

3136
## Constraints
3237

.github/agents/powershell-developer.agent.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: powershell-developer
3+
description: Implements NovaModuleTools PowerShell and helper changes with matching tests and documentation
4+
---
5+
16
# NovaModuleTools PowerShell developer agent
27

38
## Purpose
@@ -19,9 +24,11 @@ Implement PowerShell command and helper changes in the NovaModuleTools style.
1924

2025
## Skills to use
2126

22-
- `powershell-module-development.skill.md`
23-
- `pester-testing.skill.md`
24-
- `codescene-quality.skill.md`
27+
- `/powershell-module-development`
28+
- `/pester-testing`
29+
- `/codescene-quality`
30+
- `/guiding-refactoring-with-code-health`
31+
- `/safeguarding-ai-generated-code`
2532

2633
## Constraints
2734

.github/agents/release-manager.agent.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: release-manager
3+
description: Handles NovaModuleTools versioning, changelog, release-note, and publish-flow changes safely
4+
---
5+
16
# NovaModuleTools release manager agent
27

38
## Purpose
@@ -23,19 +28,19 @@ Handle versioning, changelog shaping, release-flow documentation, and publish au
2328

2429
## Skills to use
2530

26-
- `release-and-changelog.skill.md`
27-
- `markdown-authoring.skill.md`
28-
- `github-actions.skill.md`
29-
- `pester-testing.skill.md`
31+
- `/release-and-changelog`
32+
- `/markdown-authoring`
33+
- `/github-actions`
34+
- `/pester-testing`
3035

3136
## Constraints
3237

3338
- Treat release automation as high-risk.
3439
- Keep Keep a Changelog structure intact.
3540
- Distinguish contributor docs from end-user docs.
3641
- Treat `.github/pull_request_template.md` as the authoritative format for structured release summaries.
37-
- When the release summary is returned as Markdown or copy-ready UI output, it must follow
38-
`markdown-authoring.skill.md`.
42+
- When the release summary is returned as Markdown or copy-ready UI output, it must follow the `markdown-authoring`
43+
skill (`.github/skills/markdown-authoring/SKILL.md`).
3944

4045
## Definition of done
4146

.github/agents/reviewer.agent.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: reviewer
3+
description: Reviews NovaModuleTools changes for correctness, maintainability, validation, and documentation completeness
4+
---
5+
16
# NovaModuleTools reviewer agent
27

38
## Purpose
@@ -22,12 +27,13 @@ Review changes for correctness, maintainability, test coverage, workflow safety,
2227

2328
## Skills to use
2429

25-
- `codescene-quality.skill.md`
26-
- `docs-site-html.skill.md`
27-
- `markdown-authoring.skill.md`
28-
- `pester-testing.skill.md`
29-
- `github-actions.skill.md`
30-
- `release-and-changelog.skill.md`
30+
- `/codescene-quality`
31+
- `/safeguarding-ai-generated-code`
32+
- `/docs-site-html`
33+
- `/markdown-authoring`
34+
- `/pester-testing`
35+
- `/github-actions`
36+
- `/release-and-changelog`
3137

3238
## Constraints
3339

.github/agents/test-engineer.agent.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: test-engineer
3+
description: Improves NovaModuleTools Pester coverage, test structure, and CI coverage-gate behavior
4+
---
5+
16
# NovaModuleTools test engineer agent
27

38
## Purpose
@@ -20,9 +25,11 @@ Improve or maintain the repository's Pester coverage, coverage-gate behavior, an
2025

2126
## Skills to use
2227

23-
- `pester-testing.skill.md`
24-
- `codescene-quality.skill.md`
25-
- `github-actions.skill.md`
28+
- `/pester-testing`
29+
- `/codescene-quality`
30+
- `/github-actions`
31+
- `/guiding-refactoring-with-code-health`
32+
- `/safeguarding-ai-generated-code`
2633

2734
## Constraints
2835

.github/instructions/repository-instructions.md renamed to .github/copilot-instructions.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# NovaModuleTools repository instructions
1+
# NovaModuleTools Copilot instructions
22

33
## Purpose
44

5-
Use this file as the repository-local entry point for Copilot or other AI agents working in NovaModuleTools.
5+
Use this file as the repository-wide Copilot instruction entry point for NovaModuleTools.
66

77
NovaModuleTools is not a generic PowerShell repo. It has a strong split between public commands, private helpers,
88
Pester-heavy testing, GitHub Actions automation, CodeScene coverage gates, and Keep a Changelog / SemVer release flow.
@@ -15,7 +15,11 @@ Read these files before making non-trivial changes:
1515
2. `CONTRIBUTING.md`
1616
3. `.github/pull_request_template.md`
1717
4. The relevant file in `.github/instructions/`
18-
5. The relevant file in `.github/skills/`
18+
5. The relevant skill under `.github/skills/<skill-name>/SKILL.md`
19+
20+
Prompt templates under `.github/prompts/*.prompt.md` are not auto-loaded. Reference them explicitly in chat when you
21+
want
22+
to use one of the repository's reusable task prompts.
1923

2024
For new or not-yet-scoped work, start with `.github/agents/architect.agent.md` and
2125
`.github/prompts/design-change.prompt.md`. That flow should stay conversational first: analyze the request, ask
@@ -41,7 +45,7 @@ treated as final.
4145
- Keep changes small, reviewable, and easy to validate.
4246
- Do not invent behavior that is not visible in source, tests, docs, workflows, or issues.
4347
- Preserve the distinction between PowerShell cmdlet UX and `nova` CLI UX.
44-
- Review `README.md`, `CONTRIBUTING.md`, and `CHANGELOG.md` after every meaningful change.
48+
- Review `README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, and `RELEASE_NOTE.md` after every meaningful change.
4549
- Update tests when behavior changes.
4650
- Prefer existing helpers and support files over ad hoc duplication.
4751
- Treat Code Health as authoritative for maintainability in this repository.
@@ -70,7 +74,7 @@ treated as final.
7074
## Markdown output guidance
7175

7276
- When the output is intended to be copied as Markdown from the UI or written to a Markdown file, follow
73-
`.github/skills/markdown-authoring.skill.md`.
77+
the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
7478
- Apply that rule especially to release summaries, review summaries, contributor-facing Markdown docs, prompt output,
7579
and
7680
PR-template-shaped text.
@@ -89,6 +93,8 @@ When CodeScene tooling is available:
8993
- run the pre-commit safeguard on AI-touched changes before suggesting a commit
9094
- run a branch/change-set analysis before suggesting a PR or declaring a larger change ready
9195
- if CodeScene reports a regression, refactor instead of treating the work as done
96+
- use the `guiding-refactoring-with-code-health` skill for small, measured Code Health-driven refactors
97+
- use the `safeguarding-ai-generated-code` skill when deciding whether AI-touched work is ready for commit or PR handoff
9298

9399
For documentation-only changes, executable validation may be skipped if no code path or workflow behavior changed.
94100

@@ -107,8 +113,8 @@ For documentation-only changes, executable validation may be skipped if no code
107113

108114
## Related guidance
109115

110-
- `.github/instructions/powershell-coding-standards.md`
111-
- `.github/instructions/testing-policy.md`
112-
- `.github/instructions/release-policy.md`
113-
- `.github/instructions/documentation-separation.md`
114-
- `.github/skills/markdown-authoring.skill.md`
116+
- `.github/instructions/powershell-coding-standards.instructions.md`
117+
- `.github/instructions/testing-policy.instructions.md`
118+
- `.github/instructions/release-policy.instructions.md`
119+
- `.github/instructions/documentation-separation.instructions.md`
120+
- `.github/skills/markdown-authoring/SKILL.md`

.github/instructions/documentation-separation.md renamed to .github/instructions/documentation-separation.instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
applyTo: "docs/**/*.html,docs/assets/**/*.js,docs/NovaModuleTools/en-US/**/*.md,README.md,CONTRIBUTING.md,CHANGELOG.md,RELEASE_NOTE.md"
3+
---
4+
15
# NovaModuleTools documentation separation
26

37
## Purpose

.github/instructions/powershell-coding-standards.md renamed to .github/instructions/powershell-coding-standards.instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
applyTo: "src/**/*.ps1,tests/**/*.ps1,scripts/**/*.ps1,run.ps1,reload.ps1"
3+
---
4+
15
# NovaModuleTools PowerShell coding standards
26

37
## Scope

.github/instructions/release-policy.md renamed to .github/instructions/release-policy.instructions.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
applyTo: "CHANGELOG.md,RELEASE_NOTE.md,project.json,.github/workflows/Publish.yml,.github/pull_request_template.md,src/public/InvokeNovaRelease.ps1,src/public/PublishNovaModule.ps1,src/public/UpdateNovaModuleVersion.ps1,tests/**/*Release*.ps1,tests/**/*Package*.ps1"
3+
---
4+
15
# NovaModuleTools release policy
26

37
## Scope
@@ -8,8 +12,13 @@ automation.
812
## Versioning rules
913

1014
- Follow Semantic Versioning intent.
11-
- Treat `CHANGELOG.md` as authoritative for release notes.
15+
- Treat `CHANGELOG.md` as the exhaustive release history.
16+
- Treat `RELEASE_NOTE.md` as the interface-focused summary for public cmdlet, CLI, configuration, and migration changes.
1217
- Keep `## [Unreleased]` valid and readable.
18+
- If `RELEASE_NOTE.md` has no public API or workflow changes under `## [Unreleased]`, keep the exact placeholder under
19+
`### Added`: `No public API or workflow changes in this release. Internal maintenance only.`
20+
- If `RELEASE_NOTE.md` has real release-note entries, do not keep that placeholder.
21+
- Do not add compare-link footer URLs to `RELEASE_NOTE.md`.
1322
- For unreleased feature iterations, update the existing `Added` entry instead of adding an internal-history `Changed`
1423
entry.
1524

@@ -23,7 +32,7 @@ automation.
2332

2433
## Documentation rules
2534

26-
- Review `README.md`, `CONTRIBUTING.md`, and `CHANGELOG.md` for workflow or release changes.
35+
- Review `README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, and `RELEASE_NOTE.md` for workflow or release changes.
2736
- Update command help in `docs/NovaModuleTools/en-US/` when public command behavior changes.
2837
- Update `docs/*.html` only when end-user behavior or examples changed.
2938
- Use `.github/pull_request_template.md` as the authoritative structure when preparing a release summary for review.

0 commit comments

Comments
 (0)