Getting started¶

gh-plumbing exposes three integration surfaces. Pick the one that matches the change you want in your target repository.

Choose your integration¶

:material-cog-sync: Reusable workflow

Call a reusable-*.yaml workflow from your own .github/workflows/*.yaml.

:octicons-arrow-right-24: Workflow catalog
:material-robot: Probot configuration

Extend a shared commons-*.yml via _extends: without workflow changes.

:octicons-arrow-right-24: Probot configuration
:material-update: Renovate preset

Reference the shared preset in renovate.json to inherit labels and base configuration.

:octicons-arrow-right-24: See preset

.github/workflows/build-static-tests.yaml

on:
  push:

jobs:
  static:
    uses: nolte/gh-plumbing/.github/workflows/reusable-pre-commit.yaml@develop

Reference selection

@develop always tracks the latest changes; recommended for internal repositories that follow this project closely.
@vX.Y.Z pins to a released version; recommended when you need reproducibility.
master refreshes automatically on every published release and mirrors the latest release tag.

.github/settings.yml

_extends: gh-plumbing:.github/commons-settings.yml

repository:
  name: my-project
  description: My project description
  topics: example, demo

The Probot Settings App resolves the _extends: key. Local keys override inherited values.

renovate.json

{
  "extends": [
    "github>nolte/gh-plumbing//renovate-configs/common"
  ]
}

The preset enables pre-commit updates, the dependency dashboard, and applies the chore + dependencies labels.