Skip to content

Reserved interface descriptions state their contracts directly - #582

Open
Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
mainfrom
interface-description-prose
Open

Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
mainfrom
interface-description-prose

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Reserved action, settings, and reusable-workflow descriptions state their existing contracts directly. Native help uses direct prose and the existing source-backed types. The two consent descriptions omit only the final appeal. No caller action is required.

Changed: Interface and consent descriptions use direct prose

The five reserved actions retain every condition, effect, default, expression, permission, output, exact example, version constraint, and required artifact-name match. WhatIf descriptions use the action only logs so the original log-only scope stays explicit. Native help retains its tags, associations, and all 16 exact examples.

The settings schema and reusable workflows change only existing description values. Each TOML edit removes only the final consent appeal; the preceding cookie/measurement statement and all consent settings remain exact. This PR does not certify that unverified statement or repair a runtime, schema, caller, output, recovery, or release contract.

Technical details

Source: 09d209ee07418174c6835cb64b6977c2740ad962 on interface-description-prose.

Fresh main base: 64ffb1d87f86bd5d487891fdb140b78385a00531.

Seven small commits are pushed. The draft opened after the first coherent commit. The final diff contains 18 modified files, 176 insertions, and 151 deletions; it adds no repository file, test, enforcement tool, dependency, or audit Markdown.

The complete, read-back-verified evidence is attached to the closing Task:

Together, the region tables record all 109 exact replacements. The description inventory contains 56 revised YAML/JSON values, 102 no-change values, three protected existing-contract values, and two final-appeal-only TOML edits.

Changed surface Standards checked Framework/source evidence Result
Five reserved action metadata files; settings schema; five reusable workflows Pinned Natural Language, Writing Guide, YAML, GitHub Actions, Documentation; native JSON annotations Existing action contracts, settings and workflow-input references; complete structured-node and exact raw-text comparisons Prose aligned; every non-description node/value and exact constraint/example stays unchanged
Five PowerShell native-help source files Pinned PowerShell Scripts/Functions, Documentation, Natural Language; native Get-Help format Eight PowerShell candidates inspected; 22 native-help units and 16 examples Exact program tokens/flags, AST shape, requirements, directives, BOM, help tags/association, syntax and parameter contracts preserved; zero parse/analyzer findings
Two existing consent descriptions Pinned writing criteria; native TOML string format Both complete TOML files parse; docs site builds from an exact session-local copy Only the final appeal is removed; all 66 rendered pages retain the remaining statement and Accept/Reject labels

Checks: one-off exact raw-text/BOM/EOL/metadata comparisons pass for all 38 candidates; all 109 expected regions are present. Existing ConvertFrom-Yaml parses all ten changed YAML files. Existing Test-Json accepts the schema and anonymous empty settings. Invoke-ScriptAnalyzer reports zero findings on all eight PowerShell candidates before and after. zensical build --clean exits 0 with No issues found. git diff --check passes and the worktree is clean.

Default YAML lint is not reported as clean: 152 baseline findings become 138 final findings, with no new rule/region finding. Existing formatting findings remain outside the released prose scope. No local publishing, cleanup, installation, network example, fixture, or benchmark script runs. No Markdown source or link changes; all source HTTP(S) links stay exact.

The fixed writing source is MSXOrg/docs@1b0d4893c8fefabe604d04393068a8ff6f848082, including the Documentation Model, Natural Language, Writing Guide, Documentation, Markdown, applicable native formats, and Task/PR formats. The official STE overview/FAQ and local Issue 9 rules/dictionary are consulted. Manual material stays local. No full STE-conformance claim is made.

Current main, #564's protected handback, and all first-pass path exclusions are checked before every commit. Every README, Markdown source, plugin, test, both functional fixture trees, first-pass #565-#570 path, and unmatched proposal-only file stays unchanged. Existing proposal contracts and branches are not amended or woken.

Retained facts: the cookie/measurement statement remains unverified; release-note fallback wording still needs owner reconciliation with the pushed-commit-message branch; three settings descriptions remain protected; the existing all-releases and retry-count terminology and imprecise array/PSSemVer help entries remain separate contract/help questions. The full audit gives exact sources and does not select a runtime or policy fix.

Hosted services: Copilot review is explicitly requested at this final head. The request command succeeds; its captured response contains no completed review. This delivery does not wait for hosted CI/review or certify final-head completion. Earlier-head results are not substituted for final-head results. The PR remains draft; no merge, ready transition, auto-merge, Agent merge, release-label, or lifecycle setting changes.

The scoped convergence search covers the writing campaign and its source/contract siblings. Only the closing Task below is resolved by this delivery after eventual merge. Other campaign, caller, native-help, and output gaps remain non-closing context.

Related references

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
CSS Pass ✅
CSS_PRETTIER Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
HTML Pass ✅
JAVASCRIPT_ES Pass ✅
JAVASCRIPT_PRETTIER Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approved

No active review issues were identified in the description and help-text updates.

No open issues 🎉

What changed in this PR

This PR makes interface descriptions and native PowerShell help more direct across the Process-PSModule framework. Changes are limited to wording; runtime behavior, defaults, expressions, and permissions remain unchanged.

Changes:

  • Clarify five reserved actions’ descriptions while preserving existing constraints and examples.
  • Simplify reusable-workflow and settings-schema descriptions, and standardize native-help wording and type formatting.
  • Remove the final consent appeal from two cookie-consent descriptions.
File Description
docs/​zensical.toml Remove the final cookie-consent appeal.
.github/​zensical.toml Apply the same consent wording change to the template.
.github/​workflows/​workflow.yml Clarify input descriptions and test-data handling.
.github/​workflows/​Test-ModuleLocal.yml Clarify test-data exposure and masking descriptions.
.github/​workflows/​Plan.yml Simplify version, directory, and file-pattern descriptions.
.github/​workflows/​BeforeAll-ModuleLocal.yml Clarify setup test-data descriptions.
.github/​workflows/​AfterAll-ModuleLocal.yml Clarify teardown test-data descriptions.
.github/​actions/​Resolve-PSModuleVersion/​src/​Resolve-PSModuleVersion.Helpers.psm1 Rewrite native help and format selected output types.
.github/​actions/​Resolve-PSModuleVersion/​action.yml Simplify action and input descriptions.
.github/​actions/​Release-PSModule/​src/​release.ps1 Clarify script help and input/output formatting.
.github/​actions/​Release-PSModule/​action.yml Make artifact, preview, and release-note descriptions direct.
.github/​actions/​Publish-PSModule/​src/​Publish-PSModule.Helpers.psm1 Simplify version-string help and output-type formatting.
.github/​actions/​Publish-PSModule/​action.yml Clarify publishing input descriptions.
.github/​actions/​Get-PSModuleSettings/​src/​Settings.schema.json Simplify settings descriptions without changing validation.
.github/​actions/​Get-PSModuleSettings/​src/​main.ps1 Clarify test-discovery helper comments.
.github/​actions/​Get-PSModuleSettings/​src/​Get-PSModuleSettings.Helpers.psm1 Use direct wording in helper synopses.
.github/​actions/​Get-PSModuleSettings/​action.yml Clarify metadata descriptions while preserving version constraints.
.github/​actions/​Cleanup-PSModulePrereleases/​action.yml Simplify cleanup, preview, and directory descriptions.

Review effort: Balanced

This branch has not been deployed

No deployments
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.

[documentation-writing-alignment] Clarify reserved workflow and release interface descriptions

2 participants