Skip to content

Commit 0ca3b54

Browse files
docs: Add abandoned PR cleanup documentation
1 parent 71887c8 commit 0ca3b54

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,10 @@ The [PSModule - Module tests](./scripts/tests/Module/PSModule/PSModule.Tests.ps1
228228
[workflow](./.github/workflows/Publish-Module.yml)
229229
- Publishes the module to the PowerShell Gallery.
230230
- Creates a release on the GitHub repository.
231+
- **Abandoned PR cleanup**: When a PR is closed without merging (abandoned), the workflow automatically cleans up any
232+
prerelease versions and tags that were created for that PR. This ensures that abandoned work doesn't leave orphaned
233+
prereleases in the PowerShell Gallery or repository. This behavior is controlled by the `Publish.Module.AutoCleanup`
234+
setting.
231235

232236
### Build docs
233237

@@ -354,7 +358,8 @@ This table shows when each job runs based on the trigger scenario:
354358

355359
- \* Runs for cleanup if tests were started
356360
- \*\* Only when all tests/coverage/build succeed
357-
- \*\*\* Publishes cleanup/retraction version
361+
- \*\*\* Cleans up prerelease versions and tags created for the abandoned PR (when `Publish.Module.AutoCleanup` is
362+
enabled)
358363

359364
## Configuration
360365

0 commit comments

Comments
 (0)