Skip to content

📖 [Docs]: Add full dependency tree with Mermaid diagrams#368

Merged
Marius Storhaug (MariusStorhaug) merged 3 commits into
mainfrom
docs/dependency-tree
Jul 9, 2026
Merged

📖 [Docs]: Add full dependency tree with Mermaid diagrams#368
Marius Storhaug (MariusStorhaug) merged 3 commits into
mainfrom
docs/dependency-tree

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Description

Adds DEPENDENCIES.md, a full dependency tree for Process-PSModule, and links it from the README.

The document maps every layer the workflow pulls in:

  • Reusable workflows — the entry workflow.yml and the 15 stage workflows it calls.
  • GitHub Actions — the PSModule composite actions and the third-party actions.
  • Container image — the super-linter Docker action.
  • PowerShell modules — the framework tree (GitHubContextSodium, and more) and the tooling modules (Pester, PSScriptAnalyzer, Microsoft.PowerShell.PlatyPS, powershell-yaml, Markdown).
  • Python packages — the MkDocs packages installed by Build-Site.

What's included

  • Three Mermaid diagrams: workflow and action composition, action foundation with PowerShell modules, and the non-PowerShell toolchains.
  • A dependency-type taxonomy and explicit boundaries for where the tree stops.
  • Per-type reference tables with links, plus external registries and services, auxiliary workflows, and out-of-scope notes.
  • A Dependency tree section in the README linking to the new document.

Notes

  • Version pins are intentionally omitted; the workflow files under .github/workflows/ remain the source of truth.
  • Documentation-only change with no release impact. Validated with markdownlint, codespell, and textlint against the repository linter configuration.

Add DEPENDENCIES.md mapping the full Process-PSModule dependency tree: reusable workflows, PSModule and third-party actions, the super-linter container image, PowerShell modules (framework and tooling), and the MkDocs Python packages. Includes three Mermaid diagrams, per-type reference tables, and documented boundaries. Link the new doc from the README.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new documentation artifact that enumerates Process-PSModule’s dependency tree (workflows → actions → Docker image → PowerShell modules → Python packages) and links to it from the README so consumers can find the full dependency map.

Changes:

  • Add DEPENDENCIES.md containing Mermaid diagrams and reference tables for the workflow’s dependency layers.
  • Add a new “Dependency tree” subsection to README.md and include it in the README table of contents.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Adds a “Dependency tree” section and TOC entry linking readers to the new dependency documentation.
DEPENDENCIES.md Introduces the full dependency tree documentation with diagrams, boundaries, and per-layer reference tables.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread DEPENDENCIES.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 9, 2026 02:36
@MariusStorhaug Marius Storhaug (MariusStorhaug) merged commit 1514ac0 into main Jul 9, 2026
2 checks passed
@MariusStorhaug Marius Storhaug (MariusStorhaug) deleted the docs/dependency-tree branch July 9, 2026 02:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings July 9, 2026 02:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants