Open-source projects

Periphery is free for public open-source projects through the official GitHub reusable workflow. This is currently the only supported free OSS setup.

Add the workflow

Create .github/workflows/periphery.yml in your public repository:

name: Periphery

on:
  pull_request:
  push:
    branches: [main]

jobs:
  periphery:
    permissions:
      contents: read
      id-token: write
    uses: periphery-pro/actions/.github/workflows/scan.yml@v1.0.0.beta.2

Note

During the Open Beta, the workflow must be pinned to the full prerelease version shown above. The shorter @v1 reference will become available when the Open Beta ends.

The workflow builds and scans the public repository without a Periphery account or credential.

Requirements and limits

• The repository must be public.
• Run a supported version of the official workflow as shown above. Account-free local scans and custom workflow implementations are not included.
• The calling job must grant contents: read and id-token: write.

For configuring scan output, baselines, or build behaviour, see Continuous Integration.

Terms

Use of the official workflow is subject to the Periphery Terms of Use. Using this account-free workflow does not require creating a Periphery account or separately accepting the terms in a browser; enabling or running the workflow is how you accept them. The Privacy Policy describes the data processed when the workflow runs.