From 5bab50633ad876e5ecc07ceaa2040a563c4f802f Mon Sep 17 00:00:00 2001 From: Guilherme Cota <1190640@isep.ipp.pt> Date: Tue, 17 Nov 2026 15:43:47 +0000 Subject: [PATCH] docs(codereview): add verified 1.1.0 release notes --- cmf-codereview/README.md | 2 + cmf-codereview/docs/releases/1.1.0.md | 74 +++++++++++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 cmf-codereview/docs/releases/1.1.0.md diff --git a/cmf-codereview/README.md b/cmf-codereview/README.md index e9da5e8..f6309a6 100644 --- a/cmf-codereview/README.md +++ b/cmf-codereview/README.md @@ -97,4 +97,6 @@ dotnet test ## Packages for manual testing +See the [1.1.0 release notes](docs/releases/1.1.0.md) for delivered capabilities, upgrade notes, limitations, and validated package evidence. + The `Package-CodeReview` GitHub Actions workflow automatically builds and tests an all-platform package on pull requests and pushes to `main`. After the .NET tests and Windows/Linux/Intel macOS package checks pass, download the `codereview-` artifact for manual testing. Set the next version in `npm/package.json`; the workflow reads it automatically for each run. See [the package guide](docs/Releases.md) for the workflow and download instructions. Integration testing and publication are manual. diff --git a/cmf-codereview/docs/releases/1.1.0.md b/cmf-codereview/docs/releases/1.1.0.md new file mode 100644 index 0000000..5aea8f2 --- /dev/null +++ b/cmf-codereview/docs/releases/1.1.0.md @@ -0,0 +1,74 @@ +# cmf-codereview 1.1.0 + +Version 1.1.0 adds deployment Process Rule validation and SARIF reporting. The checks help reviewers identify unsafe deployment patterns before installation, and SARIF makes findings available to compatible static analysis tools. + +**Release preparation:** the package passed automated validation. Publication and integration testing in a consuming project's PR pipeline are manual; these notes do not confirm that the package has been published to a registry. + +## Process Rule validation + +Deployment-specific checks run automatically when Process Rules are included in a DEEs/Both scan. They use C# syntax and package metadata; no guideline file, AI service, or additional validation flag is required. + +- **Deployment guards and safe reruns:** flag logic placed in `DeeTestCondition`, which deployment skips, and supported mutations without matching existence/state guards in `DeeActionCode`. +- **Attribute changes:** check supported property-update patterns for existence guards, cleanup before removal, and subsequent schema regeneration for the same entity type. +- **Transaction hazards:** flag recognized Smart/Generic Table data operations when their schema is created or structurally changed by the same package version. Moving an operation to an After folder alone does not avoid this deployment transaction risk. +- **Placement and ordering:** check supported folder/content/namespace conventions, namespace-to-folder version consistency, and resolvable entity-type creator/consumer ordering. +- **Recurring migrations:** identify migration-like operations under unversioned Services that will run on every deployment. + +Unresolved helper behavior or dependencies can produce review findings rather than a claim that deployment is safe. The [rule reference](../rules.md#process-rule-deployment-validation) lists diagnostic IDs, severities, supported patterns, and limitations. + +Delivery: User Story #52869, [PR #3](https://github.com/criticalmanufacturing/cli-plugins/pull/3). + +## SARIF 2.1.0 reporting + +`scan`, `report`, and `review` can emit SARIF 2.1.0. Results include the rule ID, description, suggested fix, source path, and line number when known. Critical/High findings map to SARIF `error`; Medium maps to `warning`. + +```bash +# Scan directly to SARIF. +cmf-codereview scan --repository-root . --report-format Sarif --output findings.sarif + +# Convert an existing findings JSON file to SARIF. +cmf-codereview report --findings-path findings.json --report-format Sarif --report-path report.sarif +``` + +JSON remains the default scan output. Existing filtering, suppressions, baselines, and exit-code policy apply before SARIF rendering. Standard and Detailed report modes produce the same SARIF log. The `report --findings-path` input remains the original findings JSON, not a SARIF log. + +Posting annotations or comments requires a separately configured pipeline consumer. This release does not generate or scaffold pipelines. See the [command reference](../commands.md#sarif-output). + +Delivery: User Story #50197, [PR #4](https://github.com/criticalmanufacturing/cli-plugins/pull/4). + +## Upgrade and usage notes + +New Process Rule diagnostics can introduce additional High or Critical findings. An existing `scan --fail-on High` or `--fail-on Critical` gate can therefore start failing after the upgrade, even if the pipeline command is unchanged. + +Review the findings before enabling the new package across the team. Use the existing per-rule configuration, targeted suppressions, or a reviewed baseline for accepted debt. Create corrections in a new deployment version rather than editing already-shipped Process Rules solely to clear historical findings. + +```bash +# Run from the customization repository after restoring its dependencies. +dotnet restore +cmf-codereview scan --repository-root . --output findings.json +cmf-codereview report --findings-path findings.json --report-format Html --report-path report.html +``` + +Use `--roots` when a non-standard repository layout cannot be discovered from package metadata. Restored project dependencies remain necessary for the existing entity-aware rules. See [configuration](../configuration.md) and [commands](../commands.md). + +## Known limitations and excluded scope + +- Static checks cover recognized syntax and metadata patterns. They do not execute a deployment, prove arbitrary external helpers or callbacks safe, or verify database reruns and data preservation. Test both initial installation and repeated execution against the target environment. +- **Known schema-check gap:** `IEntityType.AddProperties(...)` is not covered by `ProcessRuleSchemaRegeneration` in this version. A clean scan does not validate schema regeneration for that operation. The implemented schema checks cover supported property-collection `Create()` and `FullUpdateEntityType(...)` patterns. +- Action Group intelligence and runtime trace correlation are deferred to v1.2.0 and are not included here. +- Pipeline generation/re-scaffolding and the remaining performance backlog are not delivered by this release; no scan-speed improvement is claimed. +- DEE UseReference and deployment-folder/package-version validation from [PR #5](https://github.com/criticalmanufacturing/cli-plugins/pull/5) is not included. Folder/namespace consistency checks described above are a separate supported Process Rule check. + +## Package and validation evidence + +The validated package contains self-contained Windows x64, Linux x64, and Intel macOS x64 executables. Other architectures are not bundled. + +| Evidence | Reference | +| --- | --- | +| Package version | `@criticalmanufacturing/codereview@1.1.0` | +| Source commit | [`4472dee43857a38b2c9b317cc1ee963061424c3d`](https://github.com/criticalmanufacturing/cli-plugins/commit/4472dee43857a38b2c9b317cc1ee963061424c3d) | +| Build and tests | [Successful CI-Build](https://github.com/criticalmanufacturing/cli-plugins/actions/runs/43845445737) | +| Archive and native installation/scan validation | [Successful Package-CodeReview](https://github.com/criticalmanufacturing/cli-plugins/actions/runs/43845445766) | +| Package for manual testing | [codereview-1.1.0 artifact](https://github.com/criticalmanufacturing/cli-plugins/actions/runs/43845445766/artifacts/14215535732) | + +Extract the artifact ZIP to obtain the `.tgz` and `manifest.json`. Keep the manifest's source commit and SHA-512 integrity with the manual test results, and publish the same tested archive. GitHub artifacts have limited retention; the package workflow retains the final artifact for 30 days. The [package guide](../Releases.md) explains downloading and manual testing. Packaging automation was added in [PR #6](https://github.com/criticalmanufacturing/cli-plugins/pull/6); the version bump was [PR #8](https://github.com/criticalmanufacturing/cli-plugins/pull/8). The automation creates no Git tags, npm tags, or GitHub releases.