Skip to content

Realign Json's managed configuration files with Template-PSModule #39

Description

Context and request

Several configuration files that are present in Json have drifted from what PSModule/Template-PSModule now ships, and one no longer matches the standard's documented default.

.github/dependabot.yml uses a weekly interval with no cooldown. The supply-chain default is daily with cooldown.default-days: 7; the standard notes that older repositories still on weekly should be aligned when the file is touched anyway.

.gitignore and .github/release.yml both differ from the template versions.

.github/mkdocs.yml is present, but the template now ships .github/zensical.toml instead. Whether Json should migrate depends on what the current Process-PSModule generation expects, which needs checking rather than assuming.

Files verified as already matching the template and needing no change: .gitattributes, .github/CODEOWNERS, and all four files under .github/linters/.

Acceptance criteria.

  • .github/dependabot.yml uses the documented default schedule and cooldown, keeping the github-actions ecosystem entry and its labels.
  • .gitignore and .github/release.yml match the template, or each difference is deliberate and recorded in the pull request.
  • The documentation site configuration matches what the pinned Process-PSModule version expects, and the site still builds and publishes.
  • No package-ecosystem value outside Dependabot's supported list is introduced.

Technical decisions

Managed files are treated as distribution artifacts, not repository-local source. Where the template and this repository differ, the template wins unless there is a module-specific reason recorded in the pull request.

No powershell ecosystem entry is added to dependabot.yml. It is not in Dependabot's supported list, and an unsupported value invalidates the entire configuration — including the github-actions entry that does work. PowerShell dependencies stay declared with #Requires -Modules in the function files that need them.

The mkdocs.yml to zensical.toml question is investigated before changing anything. If the pinned framework version still consumes mkdocs.yml, the migration is deferred to a follow-up rather than guessed at here — a broken documentation build is worse than a stale config filename.

This depends on the Process-PSModule v6 adoption landing first, since the site configuration question can only be answered against the version the repository actually runs.

Implementation plan

  • Set the github-actions entry in .github/dependabot.yml to daily with cooldown.default-days: 7
  • Diff .gitignore against the template and adopt or justify each difference
  • Diff .github/release.yml against the template and adopt or justify each difference
  • Determine which site configuration file the pinned Process-PSModule version consumes
  • Migrate to zensical.toml if required, or record why mkdocs.yml stays and open a follow-up
  • Confirm the documentation site still builds in the pull request run
  • Confirm Dependabot parses the updated configuration without error

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions