Skip to content

Prepare for prerelease and fix documentation layouts#211

Merged
stiwicourage merged 4 commits into
mainfrom
develop
May 18, 2026
Merged

Prepare for prerelease and fix documentation layouts#211
stiwicourage merged 4 commits into
mainfrom
develop

Conversation

@stiwicourage

Copy link
Copy Markdown
Owner

Summary

  • This diff prepares develop for the next prerelease by moving project.json from 3.0.0 on main to 3.0.1-preview on develop; release semantics are unchanged, so main remains the stable release branch and develop remains the prerelease branch.
  • It fixes release-facing behavior already captured under Unreleased -> Fixed by restoring wide-screen docs-site readability, removing generated run.ps1 references from the Agentic Copilot scaffold, and making nova init --example ship source-mirrored tests with Pester.CodeCoverage.Enabled = true.
  • This was needed so scaffolded projects match the supported quality loop (Invoke-ScriptAnalyzerCI.ps1 and Test-NovaBuild), the packaged example works before a build, and the docs/help match the actual scaffolded experience.
  • No linked issue or follow-up reference was provided in the reviewed diff.

Affected area

  • nova CLI or command routing
  • Public PowerShell cmdlet behavior
  • Scaffolding or project.json handling
  • Build, test, analyzer, coverage, or CI helper flow
  • Package, raw upload, or package metadata workflow
  • Publish, release, or GitHub Actions automation
  • Self-update or notification preference behavior
  • Contributor documentation (README.md, CONTRIBUTING.md, repository workflow docs)
  • End-user docs (docs/*.html)
  • Command help (docs/NovaModuleTools/en-US/*.md)
  • src/resources/example/
  • Dependency or manifest changes (project.json, workflow dependencies, release tooling)
  • Security-sensitive change
  • Documentation-only change
  • Other

Review guidance

  • Start with the scaffolded-user path: src/resources/agentic-copilot/, scripts/build/Sync-AgenticCopilotScaffold.psd1, and src/resources/example/ to confirm generated guidance and the packaged example now align with the supported repository quality loop and source-first test model.
  • Then review the release-facing docs/content updates in docs/assets/site.css, docs/*.html, docs/NovaModuleTools/en-US/Initialize-NovaModule.md, CHANGELOG.md, RELEASE_NOTE.md, and project.json.
  • Trade-offs / limitations: this is patch-level prerelease prep, not a release-flow change; touched tests describe the intended behavior, but no validation commands were executed in this review session.

Validation

  • Invoke-NovaBuild
  • Test-NovaBuild
  • ./scripts/build/Invoke-ScriptAnalyzerCI.ps1
  • ./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1
  • Targeted Nova workflow validated (% nova build, % nova test, % nova merge, % nova deploy, % nova publish, % nova release, % nova update, % nova notification, or % nova init as relevant)
  • Docs/example only; executable validation not needed

Validation notes:

No commands were executed in this review session.

The diff does include targeted test additions/updates for the changed behavior, including:
- tests/DocsSiteLayout.Tests.ps1
- tests/AgenticCopilotScaffoldSync.Tests.ps1
- tests/private/scaffold/CopyNovaExampleProjectTemplate.Tests.ps1
- tests/private/scaffold/WriteNovaModuleProjectJson.Tests.ps1
- new example scaffold tests under src/resources/example/tests/public/ and src/resources/example/tests/private/

No stable/prerelease publish scenario was exercised here, and .github/workflows/Publish.yml was reviewed as unchanged.

Documentation and release follow-up

  • README.md reviewed and updated if contributor workflow, architecture, CI, release, or automation changed
  • CONTRIBUTING.md reviewed and updated if contribution expectations or review guidance changed
  • CHANGELOG.md reviewed and updated if the change matters to users, maintainers, or contributors
  • RELEASE_NOTE.md reviewed and updated if the change affects public cmdlet usage, CLI usage, configuration semantics, or migration expectations
  • docs/NovaModuleTools/en-US/ help updated if a public command or CLI behavior changed
  • docs/*.html updated if end-user workflows or examples changed
  • src/resources/example/ reviewed and updated if the real-world project layout, package model, or upload workflow changed
  • No documentation, changelog, release-note, or example updates were needed

Maintainability, compatibility, and risk

  • Code Health / maintainability impact considered
  • No breaking change
  • Breaking change
  • Security-sensitive change
  • CI, workflow, or release-pipeline impact
  • Dependency-review impact

Risk, rollout, or rollback notes:

SemVer / release framing:
- develop is being prepared as 3.0.1-preview while main remains the 3.0.0 stable line.
- CHANGELOG.md and RELEASE_NOTE.md Unreleased entries are already shaped for the next stable release, which matches the repository release flow.

Primary risk:
- The main regression risk is mismatch between generated scaffold guidance, packaged example content, and the documented quality-loop entrypoints.

Rollback / containment:
- Rollback is localized to scaffold/example resources plus the paired docs/help/changelog updates.
- No Publish.yml behavior, tagging logic, or main/develop release semantics changed in this diff.

Important

Do not use a public pull request to disclose a vulnerability before coordinated handling.
Use the private reporting path in SECURITY.md for new security issues.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Coverage Gates Passed
Overall Coverage: 99.2% (required = 95%)
New & Changed Code Coverage: 100% (required = 99%)

Review details by gate
  • Overall Coverage

    • Pass/Fail Reason:
      The overall coverage gate was checked for all code and meets the goal: 99.2% covered >= threshold = 95%
    • Action:
      You have 285 files with a sum of 3079 covered and 24 uncovered lines of code.
  • New & Changed Code Coverage

    • Pass/Fail Reason:
      No executable lines of code changed. (The change touched 0 files).

@stiwicourage
stiwicourage merged commit b04b0d5 into main May 18, 2026
15 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.

1 participant