Skip to content

Commit 19b2789

Browse files
Tighten Plan section: describe only what Plan does, not downstream effects
1 parent 87cf094 commit 19b2789

1 file changed

Lines changed: 4 additions & 18 deletions

File tree

README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -109,24 +109,10 @@ Depending on the labels in the pull requests, the [workflow will result in diffe
109109

110110
[workflow](./.github/workflows/Plan.yml)
111111

112-
The Plan job is the single decision point of the workflow. It runs two steps in sequence:
113-
114-
1. **Get-PSModuleSettings** — loads the settings file (`.github/PSModule.yml`) and emits a fully resolved `Settings` JSON object that every downstream job consumes.
115-
2. **Resolve-PSModuleVersion** — calculates the next module version from the resolved settings and the labels on the current pull request.
116-
117-
After both steps complete, the resolved version is merged into `Settings` under a `Module` key:
118-
119-
| `Settings.Module` field | Description |
120-
| --- | ----------- |
121-
| `Version` | `Major.Minor.Patch` portion (for example `1.4.0`). |
122-
| `Prerelease` | Prerelease tag, empty when not a prerelease. |
123-
| `FullVersion` | Full string including prefix and prerelease (for example `v1.4.0-mybranch001`). |
124-
| `ReleaseType` | `Release`, `Prerelease`, or `None`. |
125-
| `CreateRelease` | `true` when a release or prerelease will be created. |
126-
127-
All downstream jobs receive this single enriched `Settings` object — there are no separate version outputs.
128-
The version decided here is the version that ships. `Build-Module` stamps it into the manifest before any test runs,
129-
and `Publish-Module` publishes the artifact unchanged.
112+
The Plan job is the single decision point of the workflow. It reads the settings file (`.github/PSModule.yml`),
113+
collects event context from GitHub, and decides what should happen in the rest of the process. Using that
114+
situational awareness it calculates the next module version. All decisions are captured in a single `Settings`
115+
object — including version data under `Settings.Module` — that every downstream job receives.
130116

131117
### Lint-Repository
132118

0 commit comments

Comments
 (0)