diff --git a/.gitattributes b/.gitattributes index 96c2e0d..6313b56 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,15 +1 @@ -# Needed for publishing of examples, build worker defaults to core.autocrlf=input. -* text eol=autocrlf - -*.mof text eol=crlf -*.sh text eol=lf -*.svg eol=lf - -# Ensure any exe files are treated as binary -*.exe binary -*.jpg binary -*.xl* binary -*.pfx binary -*.png binary -*.dll binary -*.so binary +* text=auto eol=lf diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 134e9b5..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,50 +0,0 @@ -# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners -# Each line is a file pattern followed by one or more owners. - -# These owners will be the default owners for everything in -# the repo. Unless a later match takes precedence, -# @global-owner1 and @global-owner2 will be requested for -# review when someone opens a pull request. -* @PSModule/module-maintainers - -# Order is important; the last matching pattern takes the most -# precedence. When someone opens a pull request that only -# modifies JS files, only @js-owner and not the global -# owner(s) will be requested for a review. -# *.js @js-owner - -# You can also use email addresses if you prefer. They'll be -# used to look up users just like we do for commit author -# emails. -# *.go docs@example.com - -# Teams can be specified as code owners as well. Teams should -# be identified in the format @org/team-name. Teams must have -# explicit write access to the repository. In this example, -# the octocats team in the octo-org organization owns all .txt files. -# *.txt @octo-org/octocats - -# In this example, @doctocat owns any files in the build/logs -# directory at the root of the repository and any of its -# subdirectories. -# /build/logs/ @doctocat - -# The `docs/*` pattern will match files like -# `docs/getting-started.md` but not further nested files like -# `docs/build-app/troubleshooting.md`. -# docs/* docs@example.com - -# In this example, @octocat owns any file in an apps directory -# anywhere in your repository. -# apps/ @octocat - -# In this example, @doctocat owns any file in the `/docs` -# directory in the root of your repository and any of its -# subdirectories. -# /docs/ @doctocat - -# In this example, @octocat owns any file in the `/apps` -# directory in the root of your repository except for the `/apps/github` -# subdirectory, as its owners are left empty. -# /apps/ @octocat -# /apps/github diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bc0da9d..3495acb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,12 +1,7 @@ # Contributing Follow the central [MSX contribution workflow](https://msx.no/docs/Ways-of-Working/Contribution-Workflow/) -for how to select work, create a branch, make commits, open a draft pull request, request review, -and merge changes. Use the [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/) for the -shared issue, branching, commit, pull request, and review conventions. +and [MSX Ways of Working](https://msx.no/docs/Ways-of-Working/) for shared contribution guidance. -Use the Process-PSModule documentation for repository-specific standards: - -- [Repository Standard](https://psmodule.io/Process-PSModule/reference/repository-standard/) -- [PowerShell module standard](https://psmodule.io/Process-PSModule/reference/powershell-module-standard/) -- [Validating before review](https://psmodule.io/Process-PSModule/guides/validating-before-review/) +For framework-specific guidance, review the +[Process-PSModule documentation](https://psmodule.io/Process-PSModule/). diff --git a/.github/PSModule.yml b/.github/PSModule.yml index 406464d..d45d872 100644 --- a/.github/PSModule.yml +++ b/.github/PSModule.yml @@ -1,31 +1,11 @@ -# This file is used to configure the Process-PSModule workflow. -# Reference: -# - https://github.com/PSModule/Process-PSModule?tab=readme-ov-file#configuration - Test: CodeCoverage: - PercentTarget: 0 -# Uncomment this to test faster by skipping some steps -# TestResults: -# Skip: true -# SourceCode: -# Skip: true -# PSModule: -# Skip: true -# Module: -# Windows: -# Skip: true -# MacOS: -# Skip: true -# Build: -# Docs: -# Skip: true + PercentTarget: 80 Linter: env: VALIDATE_BIOME_FORMAT: false VALIDATE_BIOME_LINT: false - VALIDATE_GITHUB_ACTIONS_ZIZMOR: false VALIDATE_JSCPD: false VALIDATE_JSON_PRETTIER: false VALIDATE_MARKDOWN_PRETTIER: false diff --git a/.github/dependabot.yml b/.github/dependabot.yml index c3f3010..f039b07 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,16 +1,7 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates - version: 2 updates: - package-ecosystem: github-actions directory: / - labels: - - dependencies - - github-actions schedule: - interval: daily - cooldown: - default-days: 7 + interval: cron + cron: '0 0 */3 * *' diff --git a/.github/linters/zizmor.yaml b/.github/linters/zizmor.yaml new file mode 100644 index 0000000..7d5aa9c --- /dev/null +++ b/.github/linters/zizmor.yaml @@ -0,0 +1,5 @@ +rules: + unpinned-uses: + config: + policies: + PSModule/Process-PSModule/.github/workflows/workflow.yml: ref-pin diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index ff2067e..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -## New: - - - -## Technical Details - - - -
-Related issues - - - -
diff --git a/AGENTS.md b/AGENTS.md index 6b70809..8b3b334 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,7 +6,4 @@ Read in this order: - what this repository is and what it contains 2. [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md) - how a change is made and reviewed -3. [Process-PSModule documentation](https://psmodule.io/Process-PSModule/) - - repository structure, module standards, and build/test/pack/publish guidance -4. [MSXOrg documentation](https://msx.no/docs/) - - central ways of working and coding standards + - how to understand the contribution process and applicable standards diff --git a/README.md b/README.md index 0150774..cf33a65 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,5 @@ The canonical starting template for new PowerShell modules in the PSModule organization. -## Purpose - -Use this template when creating a new PowerShell module repository. -It provides the CI/CD framework wiring, repository contribution guidance, and starter layout that every PSModule module repository needs. -Code of Conduct, security, and support policies are inherited from [`PSModule/.github`](https://github.com/PSModule/.github). -Process-PSModule owns release generation, so the template does not include GitHub generated-release-notes configuration. - -For step-by-step instructions, see the [template quickstart](https://psmodule.github.io/docs/Modules/Process-PSModule/template-quickstart/). - -## After creating a repository from this template - -1. Replace the `{{ NAME }}` placeholder with your module name throughout the repository. -2. Replace the starter function, test, and example with your module's first real command. -3. Set the repository description and custom properties on GitHub. -4. Confirm `.github/PSModule.yml` only overrides defaults when your module needs different behavior. -5. Open a draft pull request and run the full CI pipeline. - -See [repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) for the full checklist. - -## Prerequisites - -Modules built from this template use the [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing, and publishing. - -## Contributing - -To contribute to this template itself, read the [contribution guidelines](.github/CONTRIBUTING.md). -For agents and AI tools, start with [`AGENTS.md`](AGENTS.md). +For setup, read the framework guidance in the +[Process-PSModule documentation](https://psmodule.io/Process-PSModule/). diff --git a/examples/General.ps1 b/examples/General.ps1 deleted file mode 100644 index 79d4f26..0000000 --- a/examples/General.ps1 +++ /dev/null @@ -1,7 +0,0 @@ -<# - .SYNOPSIS - Basic module usage example. -#> - -Import-Module -Name '{{ NAME }}' -Get-PSModuleTest -Name 'World'