Skip to content

Commit c82ca36

Browse files
docs: add Template-PSModule baseline to v8 skill
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 8ae272c commit c82ca36

3 files changed

Lines changed: 86 additions & 3 deletions

File tree

.github/plugin/marketplace.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
},
77
"metadata": {
88
"description": "Agent plugins for the PSModule repository process.",
9-
"version": "1.2.0"
9+
"version": "1.3.0"
1010
},
1111
"plugins": [
1212
{
1313
"name": "psmodule",
1414
"description": "PSModule process guidance and reusable skills for PowerShell module repositories.",
15-
"version": "1.2.0",
15+
"version": "1.3.0",
1616
"source": ".github/plugin/psmodule"
1717
}
1818
]

.github/plugin/psmodule/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
33
"name": "psmodule",
44
"description": "PSModule process guidance and reusable skills for PowerShell module repositories.",
5-
"version": "1.2.0",
5+
"version": "1.3.0",
66
"author": {
77
"name": "PSModule",
88
"url": "https://github.com/PSModule"

.github/plugin/psmodule/skills/psmodule-v8-upgrade/SKILL.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,89 @@ When a legacy MkDocs configuration exists and documentation migration is in
4545
scope, migrate its content and design deliberately to Zensical, then remove
4646
the obsolete configuration only after the generated site validates.
4747

48+
## Template-PSModule baseline
49+
50+
Use [`PSModule/Template-PSModule`](https://github.com/PSModule/Template-PSModule)
51+
and the [PSModule Repository Standard](https://github.com/PSModule/Process-PSModule/blob/main/docs/content/reference/repository-standard.md)
52+
as the structural baseline for module repositories. Compare the consumer with
53+
the template's default files before adding, removing, or relocating anything.
54+
The template is a starting point, not a reason to overwrite module-specific
55+
content.
56+
57+
The expected repository anatomy is:
58+
59+
```text
60+
<ModuleName>/
61+
├── .github/
62+
│ ├── CODEOWNERS
63+
│ ├── dependabot.yml
64+
│ ├── linters/
65+
│ │ ├── .markdown-lint.yml
66+
│ │ ├── .powershell-psscriptanalyzer.psd1
67+
│ │ └── .textlintrc
68+
│ ├── PSModule.yml
69+
│ ├── pull_request_template.md
70+
│ ├── release.yml
71+
│ └── workflows/
72+
│ └── Process-PSModule.yml
73+
├── docs/
74+
│ ├── assets/
75+
│ ├── content/
76+
│ ├── overrides/
77+
│ └── zensical.toml
78+
├── examples/
79+
├── icon/
80+
├── src/
81+
│ ├── classes/
82+
│ ├── data/
83+
│ ├── formats/
84+
│ ├── functions/
85+
│ │ ├── private/
86+
│ │ └── public/
87+
│ ├── init/
88+
│ ├── modules/
89+
│ ├── scripts/
90+
│ ├── types/
91+
│ └── variables/
92+
├── tests/
93+
│ ├── AfterAll.ps1
94+
│ ├── BeforeAll.ps1
95+
│ └── <ModuleName>.Tests.ps1
96+
├── .gitattributes
97+
├── .gitignore
98+
├── AGENTS.md
99+
├── CLAUDE.md
100+
├── CODE_OF_CONDUCT.md
101+
├── CONTRIBUTING.md
102+
├── LICENSE
103+
├── README.md
104+
├── SECURITY.md
105+
└── SUPPORT.md
106+
```
107+
108+
Treat files and directories as follows:
109+
110+
- Required baseline files should be present in the consumer and remain
111+
repository-local; do not rely on organization-level fallback files.
112+
- `src/`, especially `src/functions/public/` and `src/functions/private/`,
113+
along with `tests/`, `examples/`, and `icon/`, is module-owned content.
114+
Preserve its intent and only migrate paths when the framework contract
115+
requires it.
116+
- `.github/PSModule.yml`, linters, Dependabot, CODEOWNERS, release metadata,
117+
pull-request templates, and repository guidance are configuration surfaces.
118+
Inspect and preserve them independently of the caller workflow.
119+
- `tests/BeforeAll.ps1` and `tests/AfterAll.ps1` are optional root-level
120+
module-local phases, not recursively discovered test files.
121+
- Optional source folders such as `assemblies`, `formats`, `types`, `variables`,
122+
`data`, `modules`, and `scripts` are added when the module needs them; do not
123+
create empty placeholders solely to match the tree.
124+
125+
If the template revision and the consumer's existing layout disagree, record
126+
the difference and migrate only the requested integration surface. In
127+
particular, this v8 skill uses `docs/zensical.toml`, `docs/content/`,
128+
`docs/overrides/`, and `docs/assets/` as the documentation contract described
129+
below; do not create a second configuration under `.github/`.
130+
48131
## Caller workflow contract
49132

50133
Replace `.github/workflows/Process-PSModule.yml` with exactly this template:

0 commit comments

Comments
 (0)