Skip to content

Commit 2001551

Browse files
Document consumer artifact root
1 parent 16077b9 commit 2001551

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docs/content/reference/pipeline-stages.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@ implements it.
1111

1212
For which of these jobs run in a given trigger scenario, see the [scenario matrix](scenario-matrix.md).
1313

14+
## Consumer artifact root
15+
16+
The framework stores consumer build, documentation, test, and coverage artifacts
17+
under `<WorkingDirectory>/.PSModule/`. This keeps generated output separate from
18+
the module source. Consumer repositories SHOULD ignore `.PSModule/`.
19+
20+
| Path | Contents |
21+
| --- | --- |
22+
| `.PSModule/module/` | The compiled, versioned module artifact. |
23+
| `.PSModule/docs/` | Generated command documentation passed to the site build. |
24+
| `.PSModule/site/` | Assembled site input and generated static site output at `_site/`. |
25+
| `.PSModule/TestResult/` | Per-suite Pester and analyzer test-result reports. |
26+
| `.PSModule/CodeCoverage/` | Per-suite code-coverage reports. |
27+
28+
Pester stores its temporary execution state outside the consumer checkout.
29+
Runner-only output, including `TestResults/`, `CodeCoverage/`,
30+
`CodeCoverage-MissedPaths/`, and `super-linter-output/`, is not a consumer
31+
repository artifact.
32+
1433
## Plan
1534

1635
[workflow](https://github.com/PSModule/Process-PSModule/blob/main/.github/workflows/Plan.yml)

0 commit comments

Comments
 (0)