Skip to content

Commit 05cd2ab

Browse files
πŸ“– [Docs]: Process-PSModule reference links now reach current sources (#450)
Process-PSModule reference pages now lead to the current framework test sources, site-publishing workflow, and composition entry points. Readers no longer encounter links that point to moved files or the removed dependency inventory. ## Fixed: Reference links reach the current framework sources The pipeline guide now links to the source-code and module test directories that enforce the framework standards, and its publishing-stage link reaches the active site-publishing workflow. The framework test ID reference links directly to each current test file. ## Changed: Dependency reference shows the maintained composition The dependency reference now directs readers to the reusable workflows and composite actions that define the current Process-PSModule composition instead of the removed `DEPENDENCIES.md` file. --- <details> <summary>Technical details</summary> - Repaired links only in `pipeline-stages.md`, `framework-test-ids.md`, and `dependencies.md`. - Canonical targets are `.github/actions/Test-PSModule/src/tests/{SourceCode,Module}`, their `PSModule.Tests.ps1` files, `.github/workflows/Publish-Site.yml`, `.github/workflows`, and `.github/actions`. - Implementation plan progress: all three requested page repairs are complete. The cross-repository-link checker from `MSXOrg/docs#145` is deliberately excluded: it needs separate CI/test integration, and its root-test layout is incompatible with this repository's Test-Actions discovery. - Standards and framework alignment pass: | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | | `docs/content/reference/**` (Markdown) | Markdown | Process-PSModule documentation | Aligned | - Issue convergence sweep: scoped to documentation link repairs associated with `MSXOrg/docs#145`; no open issue is fully satisfied by this repository-local documentation repair. - Validation: `Push-Location docs; zensical build --clean; $exitCode = $LASTEXITCODE; Pop-Location; exit $exitCode` passed. Draft PR checks passed: Docs Build, Docs Lint (including Markdown), repository Lint code base, and Analyze (actions). </details> <details> <summary>Relevant issues (or links)</summary> ### Related work - References MSXOrg/docs#145 </details> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent f86c419 commit 05cd2ab

3 files changed

Lines changed: 8 additions & 7 deletions

File tree

β€Ždocs/content/reference/dependencies.mdβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ packages. Each is versioned independently, and the main workflow pins versions e
2222
| PowerShell Gallery API | Publishes module packages. |
2323
| GitHub Pages | Hosts the documentation site. |
2424

25-
For the full dependency tree, including diagrams and a reference of every transitive dependency, see
26-
[DEPENDENCIES.md](https://github.com/PSModule/Process-PSModule/blob/main/DEPENDENCIES.md).
25+
The composition itself is the reference: see the
26+
[reusable workflows](https://github.com/PSModule/Process-PSModule/tree/main/.github/workflows) and the
27+
[actions they call](https://github.com/PSModule/Process-PSModule/tree/main/.github/actions).

β€Ždocs/content/reference/framework-test-ids.mdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ source-code test has an ID that can be used to
1212
## Source-code tests
1313

1414
Run by the [Test source code](pipeline-stages.md#test-source-code) job against files in `src/`. Implemented in
15-
[PSModule - SourceCode tests](https://github.com/PSModule/Process-PSModule/blob/main/scripts/tests/SourceCode/PSModule/PSModule.Tests.ps1).
15+
[PSModule - SourceCode tests](https://github.com/PSModule/Process-PSModule/blob/main/.github/actions/Test-PSModule/src/tests/SourceCode/PSModule/PSModule.Tests.ps1).
1616

1717
| ID | Category | Description | Example skip comment |
1818
| ---- | ---------- | ------------- | ---------------------- |
@@ -32,7 +32,7 @@ Run by the [Test source code](pipeline-stages.md#test-source-code) job against f
3232

3333
Run by the [Framework test](pipeline-stages.md#framework-test) job against the compiled module in
3434
`outputs/module`. Implemented in
35-
[PSModule - Module tests](https://github.com/PSModule/Process-PSModule/blob/main/scripts/tests/Module/PSModule/PSModule.Tests.ps1).
35+
[PSModule - Module tests](https://github.com/PSModule/Process-PSModule/blob/main/.github/actions/Test-PSModule/src/tests/Module/PSModule/PSModule.Tests.ps1).
3636

3737
| Name | Description |
3838
| ---- | ----------- |

β€Ždocs/content/reference/pipeline-stages.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ suite matrices are computed under each owning test phase, and resolved version m
6464
[workflow](https://github.com/PSModule/Process-PSModule/blob/main/.github/workflows/Test-SourceCode.yml)
6565

6666
- Tests the source code in parallel (matrix) using:
67-
- [PSModule framework settings for style and standards for source code](https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#sourcecode-tests)
67+
- [PSModule framework settings for style and standards for source code](https://github.com/PSModule/Process-PSModule/tree/main/.github/actions/Test-PSModule/src/tests/SourceCode)
6868
- This produces a JSON-based report that is used by [Get-PesterTestResults](#get-test-results) evaluate the results of the tests.
6969

7070
For the coding practices this step enforces, see [framework test IDs](framework-test-ids.md#source-code-tests).
@@ -82,7 +82,7 @@ For the coding practices this step enforces, see [framework test IDs](framework-
8282
[workflow](https://github.com/PSModule/Process-PSModule/blob/main/.github/workflows/Test-Module.yml)
8383

8484
- Tests and lints the module in parallel (matrix) using:
85-
- [PSModule framework settings for style and standards for modules](https://github.com/PSModule/Test-PSModule?tab=readme-ov-file#module-tests)
85+
- [PSModule framework settings for style and standards for modules](https://github.com/PSModule/Process-PSModule/tree/main/.github/actions/Test-PSModule/src/tests/Module)
8686
- [PSScriptAnalyzer rules](https://github.com/PSModule/Invoke-ScriptAnalyzer)
8787
- This produces a JSON-based report that is used by [Get-PesterTestResults](#get-test-results) evaluate the results of the tests.
8888
- **Code coverage for framework-generated code**: This step collects code coverage for framework-generated
@@ -160,4 +160,4 @@ How to write these tests, including the Pester version requirement and shared-in
160160

161161
## Publish Docs
162162

163-
[workflow](https://github.com/PSModule/Process-PSModule/blob/main/.github/workflows/Publish-Docs.yml)
163+
[workflow](https://github.com/PSModule/Process-PSModule/blob/main/.github/workflows/Publish-Site.yml)

0 commit comments

Comments
Β (0)