Skip to content

Commit 8ae272c

Browse files
docs: enrich Process-PSModule v8 upgrade skill
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 34af15a commit 8ae272c

3 files changed

Lines changed: 43 additions & 4 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.1.0"
9+
"version": "1.2.0"
1010
},
1111
"plugins": [
1212
{
1313
"name": "psmodule",
1414
"description": "PSModule process guidance and reusable skills for PowerShell module repositories.",
15-
"version": "1.1.0",
15+
"version": "1.2.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.1.0",
5+
"version": "1.2.0",
66
"author": {
77
"name": "PSModule",
88
"url": "https://github.com/PSModule"

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

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,25 @@ consumer repositories while developing or validating this skill.
2626
Use the repository's applicable MSX workflow and PR format guidance. Do not
2727
silently broaden the scope when the consumer has unrelated failures.
2828

29+
## Consumer layout variance
30+
31+
Do not assume that a consumer already resembles Process-PSModule. Inventory
32+
what is present before deciding what to migrate:
33+
34+
- Many consumers have a legacy `.github/mkdocs.yml` and no `docs/` directory.
35+
- Some consumers already have `docs/zensical.toml`, custom overrides, and
36+
assets that must be preserved.
37+
- A consumer may already declare Pester 6; do not repeat a dependency migration
38+
that is already complete.
39+
- Existing repository-owned workflows, scripts, and settings are not caller
40+
workflow extensions. Keep them in separate files and validate them in place.
41+
42+
When documentation is absent, do not invent a site as part of the caller
43+
upgrade unless the requested scope explicitly includes documentation migration.
44+
When a legacy MkDocs configuration exists and documentation migration is in
45+
scope, migrate its content and design deliberately to Zensical, then remove
46+
the obsolete configuration only after the generated site validates.
47+
2948
## Caller workflow contract
3049

3150
Replace `.github/workflows/Process-PSModule.yml` with exactly this template:
@@ -92,6 +111,24 @@ the existing names and semantics. Omit `TestData` entirely when the repository
92111
does not use it. Never move secrets into source files, workflow `env`, or
93112
committed settings.
94113

114+
For example, preserve a secrets-only caller payload such as PSModule/GitHub's:
115+
116+
```yaml
117+
TestData: >-
118+
{"secrets":{"TEST_USER_USER_FG_PAT":"${{ secrets.TEST_USER_USER_FG_PAT }}","TEST_USER_ORG_FG_PAT":"${{ secrets.TEST_USER_ORG_FG_PAT }}","TEST_USER_PAT":"${{ secrets.TEST_USER_PAT }}","TEST_APP_ORG_CLIENT_ID":"${{ secrets.TEST_APP_ORG_CLIENT_ID }}","TEST_APP_ORG_PRIVATE_KEY":"${{ secrets.TEST_APP_ORG_PRIVATE_KEY }}","TEST_APP_ENT_CLIENT_ID":"${{ secrets.TEST_APP_ENT_CLIENT_ID }}","TEST_APP_ENT_PRIVATE_KEY":"${{ secrets.TEST_APP_ENT_PRIVATE_KEY }}"}}
119+
```
120+
121+
Preserve a mixed secrets-and-variables payload such as PSModule/Confluence's:
122+
123+
```yaml
124+
TestData: >-
125+
{"secrets":{"CONFLUENCE_API_TOKEN":"${{ secrets.CONFLUENCE_API_TOKEN }}"},"variables":{"CONFLUENCE_SITE":"${{ vars.CONFLUENCE_SITE }}","CONFLUENCE_USERNAME":"${{ vars.CONFLUENCE_USERNAME }}","CONFLUENCE_SPACE_KEY":"${{ vars.CONFLUENCE_SPACE_KEY }}"}}
126+
```
127+
128+
These examples are contracts, not values to copy into an unrelated consumer.
129+
Read the original workflow and preserve only the maps and keys it actually
130+
uses.
131+
95132
## Documentation integration
96133

97134
Treat `docs/zensical.toml` as authoritative. Do not create or maintain
@@ -117,7 +154,9 @@ the existing consumer source of truth, then validate the generated site.
117154
The framework upgrade does not permit leaving tests on an undeclared or
118155
unsupported Pester version. Inspect module requirements, dependency manifests,
119156
local setup, CI installation, and every test entry point. Declare and run the
120-
repository's supported Pester 6 dependency.
157+
repository's supported Pester 6 dependency. If Pester 6 is already declared,
158+
retain the declaration and focus on configuration, discovery, assertions,
159+
setup/teardown, and output compatibility.
121160

122161
Rewrite tests using native Pester v6 terminology and APIs:
123162

0 commit comments

Comments
 (0)