Skip to content

Move GitHub API defaults out of maester-config.json #2129

Description

@merill

Summary

GitHubApiBaseUri and GitHubApiVersion are currently populated with their standard values in tests/maester-config.json, even though Connect-MtGitHub already provides and validates the same defaults in code.

The baseline configuration should contain user or tenant overrides, not duplicate product defaults.

Proposed change

  • Remove GitHubApiBaseUri and GitHubApiVersion from the shipped tests/maester-config.json.
  • Keep the existing resolution order in Connect-MtGitHub:
    1. Explicit cmdlet parameter
    2. Custom maester-config.json setting
    3. Code default
  • Retain the current validated code defaults:
    • https://api.github.com
    • 2022-11-28
  • Preserve support for GHE.com and explicit API-version overrides.
  • Add or adjust tests to prove the code defaults are used when the settings are absent.
  • Document these as optional override settings.

Rationale

This keeps the shipped configuration focused on actual configuration data and avoids presenting built-in defaults as if users need to manage them. It also provides one authoritative location for defaults while preserving all existing override behavior.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions