Skip to content

📖 [Docs]: Module dependency declaration using #Requires -Modules now documented #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
Open

📖 [Docs]: Module dependency declaration using #Requires -Modules now documented #297

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc86f85
Initial plan
Copilot Mar 13, 2026
0f9c85c
docs: add documentation for declaring module dependencies using #Requ…
Copilot Mar 13, 2026
88c2bf5
docs: simplify folder tree annotations, revise dependency docs, add m…
Copilot Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,6 +953,21 @@ How the module is built.
│ └── README.md # Module-level docs ingested by Document-PSModule
```

### Declaring module dependencies

Declare module dependencies using
[`#Requires -Modules`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_requires)
statements at the top of function files in `src/functions/public/` or `src/functions/private/` that require external modules.
[Build-PSModule](https://github.com/PSModule/Build-PSModule) collects every `#Requires -Modules` declaration across all
source files, de-duplicates the list, and writes it into the `RequiredModules` field of the compiled manifest
automatically. For the full range of supported syntax variants, see the
[about_Requires](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_requires)
documentation.

> [!IMPORTANT]
> Adding `RequiredModules` to `src/manifest.psd1` is **not** supported for this purpose. Those entries are silently
> ignored by the build and will not appear in the compiled manifest. Use `#Requires -Modules` in function files instead.

## Principles and practices

The contribution and release process is based on the idea that a PR is a release, and we only maintain a single linear ancestry of versions, not going
Expand All @@ -965,6 +980,9 @@ For each topic or feature to add to the release, open a new branch representing
branch. Optionally add the `Prerelease` label on the PR for the release branch, to release preview versions before merging and releasing a published
version of the PowerShell module.

Co-locate concerns for long-term maintainability. For example, `#Requires -Modules` statements belong in the function files that use them, not in a
central manifest — this makes it immediately visible which functions drive each external dependency, and avoids silent drift between the manifest and
the actual code.

The process is compatible with:

Expand Down
Loading