docs(specs): add v1 spec and upgrade Process-PSModule caller to v8 - #33
Draft
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Draft
docs(specs): add v1 spec and upgrade Process-PSModule caller to v8#33Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Conversation
Defines the initial public API for the PowerShellGallery module: - API metadata discovery - Package search and metadata retrieval - Listing management (hide/show) for package owners Includes naming conventions, parameter design, error handling, testing strategy, and migration notes from current stubs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
- Replace .github/workflows/Process-PSModule.yml with the v8 caller contract
(exact triggers, permissions, concurrency, and secrets; no secrets inherit).
- Migrate tests to Pester 6: add #Requires, suppress PSSA attributes, and
update assertions to v6-compatible syntax.
- Add missing repository baseline files: AGENTS.md, CONTRIBUTING.md, and
.github/pull_request_template.md.
- Migrate documentation from MkDocs to Zensical:
- Remove .github/mkdocs.yml
- Add docs/zensical.toml with docs_dir = 'content'
- Add docs/content/index.md and move docs/specs/v1.md to
docs/content/specs/v1.md
- Copy icon/icon.png to docs/content/Assets/icon.png
- Ignore generated docs/site/
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug)
changed the title
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v8 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR lands two related pieces of groundwork for the v1 release:
PowerShellGallerymodule.v1 specification
Defines the initial public API for the module:
Get-PowerShellGalleryAPIFind-PowerShellGalleryPackageGet-PowerShellGalleryPackageHide-PowerShellGalleryPackage(Unlist-PowerShellGalleryPackage)Show-PowerShellGalleryPackage(List-PowerShellGalleryPackage)The spec is located at
docs/content/specs/v1.mdand covers naming conventions, private-helper responsibilities, error handling, authentication, testing approach, and migration from the current stubs.v8 upgrade details
.github/workflows/Process-PSModule.ymlwith the exact v8 caller contract.tests/PowerShellGallery.Tests.ps1to Pester 6 (#Requires, native v6 assertions).AGENTS.md,CONTRIBUTING.md,.github/pull_request_template.md.docs/zensical.tomlwithdocs_dir = "content".docs/content/index.mdand moveddocs/specs/v1.mdtodocs/content/specs/v1.md.icon/icon.pngtodocs/content/Assets/icon.png.docs/site/in.gitignore.Validation
zensical build --cleancompletes with no issues.Notes
Hide-PowerShellGalleryItem/Show-PowerShellGalleryItemare planned to be renamed to*Packagewith backward-compatible aliases; the spec documents this migration.Related docs