Skip to content

Commit 728ce8a

Browse files
⚙️ [Maintenance]: Template baseline stays current (#58)
Repositories created from this template inherit centralized Process-PSModule guidance, leaner template metadata, updated automation defaults, and consistent LF text checkouts. Existing repositories are unaffected. ## Changed: Template guidance New template consumers start with the canonical [Process-PSModule documentation](https://psmodule.io/Process-PSModule/). `AGENTS.md` directs readers to the local README and contributing guide, and the contributing guide links to the central MSX and Process-PSModule guidance. ## Changed: Template baseline New repositories no longer include the optional starter example, local CODEOWNERS file, or local pull-request template. Dependabot checks GitHub Actions dependencies every third day without custom labels. The template coverage target is 80%, and its scoped zizmor policy permits the owned Process-PSModule reusable-workflow `@v8` reference while retaining default hash-pinning requirements for other action references. ## Changed: Cross-platform line endings Git uses `text=auto eol=lf` for the template. Detected text files are stored and checked out with LF line endings on Windows, macOS, and Linux. Git continues to leave detected binary content, including the template icon, unchanged. ## Adopting this release This applies only when creating a repository from this template revision. No configuration, code, or invocation changes are required beyond selecting this template revision. ## Release impact | Field | Value | | --- | --- | | Effective decision | `release:skip` label, selected for internal template maintenance. | | Semantic effect | No release is produced. | | Release/base coordinates | No version or release coordinates apply. | --- <details> <summary>Technical details</summary> ### Consumer change record | Identifier / surface | Before | After | Applicability / prerequisites | Consumer action | Verification | | --- | --- | --- | --- | --- | --- | | Template guidance | Retired deep documentation links and duplicated navigation. | Canonical Process-PSModule entry point and local agent-to-contributor navigation. | New repositories created from this template. | Select this template revision. | Tracked guidance references the canonical Process-PSModule documentation entry point. | | Template automation baseline | Daily Dependabot checks, placeholder ownership and pull-request-template files, no zizmor policy, and no default coverage target. | Three-day Dependabot cadence, an 80% coverage target, a scoped zizmor configuration, and removed unused placeholders. | New repositories created from this template. | Select this template revision and customize repository-specific policy where needed. | Modified YAML configuration is valid and the scoped policy covers the owned reusable workflow reference. | | Cross-platform line endings | Redundant type-specific rules supplemented the generic text policy. | `text=auto eol=lf` makes detected text use LF and relies on Git binary detection. | New and fresh checkouts of this template. | Select this template revision. | `git ls-files --eol` identifies the template icon as binary and Git reports LF in the index for tracked text files. | ### Template baseline | Field | Evidence | | --- | --- | | Producer identity | Not applicable; this pull request changes the template repository itself. | | Template identity | `PSModule/Template-PSModule` candidate commit `e15cff75dc679dde8fa49527656c5e2aca643289`. | | Compatibility evidence | The existing caller workflow continues to reference `PSModule/Process-PSModule/.github/workflows/workflow.yml@v8`, and the scoped zizmor policy permits that owned mutable-major reference. | | Template work | Delivered by this pull request. | ### Maintainer evidence | Changed surface | Standards checked | Framework docs checked | Result | | --- | --- | --- | --- | | `README.md`, `AGENTS.md`, `.github/CONTRIBUTING.md` | Markdown and natural-language guidance | Process-PSModule documentation and MSX contribution guidance | Aligned | | `.github/dependabot.yml`, `.github/PSModule.yml`, `.github/linters/zizmor.yaml` | YAML and GitHub Actions guidance | Process-PSModule settings | Aligned | | `.gitattributes` | Git cross-platform line-ending behavior | Git `gitattributes` documentation | Aligned | | Template placeholder removals | Repository baseline | None | Aligned | </details> <details> <summary>Relevant issues (or links)</summary> ### Related work - None. </details>
1 parent 7355840 commit 728ce8a

10 files changed

Lines changed: 15 additions & 179 deletions

File tree

‎.gitattributes‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1 @@
1-
# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
2-
* text eol=autocrlf
3-
4-
*.mof text eol=crlf
5-
*.sh text eol=lf
6-
*.svg eol=lf
7-
8-
# Ensure any exe files are treated as binary
9-
*.exe binary
10-
*.jpg binary
11-
*.xl* binary
12-
*.pfx binary
13-
*.png binary
14-
*.dll binary
15-
*.so binary
1+
* text=auto eol=lf

‎.github/CODEOWNERS‎

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎.github/CONTRIBUTING.md‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
# Contributing
22

33
Follow the central [MSX contribution workflow](https://msx.no/docs/Ways-of-Working/Contribution-Workflow/)
4-
for how to select work, create a branch, make commits, open a draft pull request, request review,
5-
and merge changes. Use the [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/) for the
6-
shared issue, branching, commit, pull request, and review conventions.
4+
and [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/) for shared contribution guidance.
75

8-
Use the Process-PSModule documentation for repository-specific standards:
9-
10-
- [Repository Standard](https://psmodule.io/Process-PSModule/reference/repository-standard/)
11-
- [PowerShell module standard](https://psmodule.io/Process-PSModule/reference/powershell-module-standard/)
12-
- [Validating before review](https://psmodule.io/Process-PSModule/guides/validating-before-review/)
6+
For framework-specific guidance, review the
7+
[Process-PSModule documentation](https://psmodule.io/Process-PSModule/).

‎.github/PSModule.yml‎

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,11 @@
1-
# This file is used to configure the Process-PSModule workflow.
2-
# Reference:
3-
# - https://github.com/PSModule/Process-PSModule?tab=readme-ov-file#configuration
4-
51
Test:
62
CodeCoverage:
7-
PercentTarget: 0
8-
# Uncomment this to test faster by skipping some steps
9-
# TestResults:
10-
# Skip: true
11-
# SourceCode:
12-
# Skip: true
13-
# PSModule:
14-
# Skip: true
15-
# Module:
16-
# Windows:
17-
# Skip: true
18-
# MacOS:
19-
# Skip: true
20-
# Build:
21-
# Docs:
22-
# Skip: true
3+
PercentTarget: 80
234

245
Linter:
256
env:
267
VALIDATE_BIOME_FORMAT: false
278
VALIDATE_BIOME_LINT: false
28-
VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
299
VALIDATE_JSCPD: false
3010
VALIDATE_JSON_PRETTIER: false
3111
VALIDATE_MARKDOWN_PRETTIER: false

‎.github/dependabot.yml‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,7 @@
1-
# To get started with Dependabot version updates, you'll need to specify which
2-
# package ecosystems to update and where the package manifests are located.
3-
# Please see the documentation for all configuration options:
4-
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5-
61
version: 2
72
updates:
83
- package-ecosystem: github-actions
94
directory: /
10-
labels:
11-
- dependencies
12-
- github-actions
135
schedule:
14-
interval: daily
15-
cooldown:
16-
default-days: 7
6+
interval: cron
7+
cron: '0 0 */3 * *'

‎.github/linters/zizmor.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
rules:
2+
unpinned-uses:
3+
config:
4+
policies:
5+
PSModule/Process-PSModule/.github/workflows/workflow.yml: ref-pin

‎.github/pull_request_template.md‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎AGENTS.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,4 @@ Read in this order:
66
- what this repository is and what it contains
77
2. [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md)
88
- how a change is made and reviewed
9-
3. [Process-PSModule documentation](https://psmodule.io/Process-PSModule/)
10-
- repository structure, module standards, and build/test/pack/publish guidance
11-
4. [MSXOrg documentation](https://msx.no/docs/)
12-
- central ways of working and coding standards
9+
- how to understand the contribution process and applicable standards

‎README.md‎

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,5 @@
22

33
The canonical starting template for new PowerShell modules in the PSModule organization.
44

5-
## Purpose
6-
7-
Use this template when creating a new PowerShell module repository.
8-
It provides the CI/CD framework wiring, repository contribution guidance, and starter layout that every PSModule module repository needs.
9-
Code of Conduct, security, and support policies are inherited from [`PSModule/.github`](https://github.com/PSModule/.github).
10-
Process-PSModule owns release generation, so the template does not include GitHub generated-release-notes configuration.
11-
12-
For step-by-step instructions, see the [template quickstart](https://psmodule.github.io/docs/Modules/Process-PSModule/template-quickstart/).
13-
14-
## After creating a repository from this template
15-
16-
1. Replace the `{{ NAME }}` placeholder with your module name throughout the repository.
17-
2. Replace the starter function, test, and example with your module's first real command.
18-
3. Set the repository description and custom properties on GitHub.
19-
4. Confirm `.github/PSModule.yml` only overrides defaults when your module needs different behavior.
20-
5. Open a draft pull request and run the full CI pipeline.
21-
22-
See [repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) for the full checklist.
23-
24-
## Prerequisites
25-
26-
Modules built from this template use the [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing, and publishing.
27-
28-
## Contributing
29-
30-
To contribute to this template itself, read the [contribution guidelines](.github/CONTRIBUTING.md).
31-
For agents and AI tools, start with [`AGENTS.md`](AGENTS.md).
5+
For setup, read the framework guidance in the
6+
[Process-PSModule documentation](https://psmodule.io/Process-PSModule/).

‎examples/General.ps1‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)