Skip to content

Commit f2cb622

Browse files
📖 [Docs]: Remove TestData parity details from README
1 parent 4bbdf43 commit f2cb622

1 file changed

Lines changed: 0 additions & 27 deletions

File tree

README.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,3 @@ The full documentation lives on the MSX / Docs site:
99
📖 **[Process-PSModule documentation](https://msxorg.github.io/docs/Frameworks/Process-PSModule/)**
1010

1111
It covers getting started, the pipeline stages, usage, configuration, repository structure, and the principles behind the framework.
12-
13-
## TestData phase parity
14-
15-
Module-local setup, test, and teardown phases use the same `TestData` contract. Values under
16-
`secrets` are masked and values under `variables` are exported unmasked, and every key is available
17-
as `$env:<name>` in all three phases:
18-
19-
- `BeforeAll-ModuleLocal` (`tests/BeforeAll.ps1`)
20-
- `Test-ModuleLocal` (Pester module tests)
21-
- `AfterAll-ModuleLocal` (`tests/AfterAll.ps1`)
22-
23-
Pass `TestData` as a single-line JSON object from the calling workflow:
24-
25-
```yaml
26-
jobs:
27-
Process-PSModule:
28-
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v6
29-
secrets:
30-
APIKey: ${{ secrets.APIKey }}
31-
TestData: >-
32-
{ "secrets": { "TEST_TOKEN": "${{ secrets.TEST_TOKEN }}" },
33-
"variables": { "TEST_OWNER": ${{ toJSON(vars.TEST_OWNER) }} } }
34-
```
35-
36-
If a key is missing in setup or teardown, verify that the caller explicitly maps `TestData` as JSON.
37-
`secrets: inherit` only passes a repository or environment secret already named `TestData`; it does not
38-
automatically build the JSON object from individual secrets.

0 commit comments

Comments
 (0)