Skip to content

API

Project-specific overrides for pyrig-private configuration.

rig

Overrides for pyrig project configuration and tooling.

configs

Overrides for managed configuration files.

version_control

Overrides for version-control configuration.

remote

Overrides for remote version-control configuration.

settings

Repository-level settings and protection ruleset configuration for GitHub.

RepositorySettingsConfigFile

Bases: RepositorySettingsConfigFile, RepositorySettingsConfigFile

GitHub settings that keep the pyrig-private project repository public.

Combine the project's repository settings with public requirements.

visibility
visibility() -> str

Return the public visibility required by this plugin.

pyrig-private is itself an open-source project and dogfoods this override package, so its generated repository must remain public.

Returns:

Type Description
str

The repository visibility value, "public".

Source code in src/pyrig_private_overrides/rig/configs/version_control/remote/settings.py
def visibility(self) -> str:
    """Return the public visibility required by this plugin.

    ``pyrig-private`` is itself an open-source project and dogfoods this
    override package, so its generated repository must remain public.

    Returns:
        The repository visibility value, ``"public"``.
    """
    return PublicRepositorySettingsConfigFile().visibility()