Oore CI
CLI

`oore pipeline validate`

Validate repository pipeline YAML with the same schema used by the runner.

oore pipeline validate [PATH]
oore pipeline validate [PATH] --project <PROJECT_ID> [--pipeline <PIPELINE_ID>]
                       [--daemon-url <URL>] [--token <TOKEN>]

PATH defaults to .oore.yaml. The command reads the selected file and validates it with the runner’s repository pipeline parser. It accepts version: 1 and version: 2 files, and for version 2 checks every workflow, including vars, step and target references.

oore pipeline validate
oore pipeline validate config/mobile.oore.yaml

A valid file prints:

.oore.yaml is valid

Invalid YAML, an unknown field, an unsupported schema version, an empty platform list, a duplicate environment key, an invalid artifact pattern, or an undefined or cyclic reference returns a non-zero exit and a specific validation message. Shape errors include the line and column.

For a version 2 file, the command prints note: lines on standard error for settings that change how the pipeline behaves, such as on replacing the trigger settings, publish replacing the Publish settings, or a workflow that publishes to Google Play without an Android build that makes an App Bundle. It still exits successfully.

Without --project, the command validates only the selected file. It does not contact the backend, create a pipeline, or verify whether every command-line tool used by the pipeline is installed.

Check against a project

With --project, the command also checks the credentials and secrets the file names against that project, through the API, after the file itself is valid:

OptionEffect
--project PROJECT_IDThe project whose signing library and secrets to check against.
--pipeline PIPELINE_IDAlso count this pipeline’s secrets. The pipeline must belong to the project.
--daemon-urlBackend URL; otherwise uses environment, CLI config, then loopback.
--tokenSession token; otherwise OORE_SESSION_TOKEN or the session stored by oore login.

The session needs read access to the project. For every workflow, with every target it builds, the command checks:

  • each name under signing, at the top level or in the workflow, against GET /v1/projects/{project_id}/signing-identities: the identity exists, signing.android names an Android keystore and signing.ios an iOS distribution identity;
  • that a workflow which uploads to App Store Connect does not name an iOS identity with ad hoc profiles;
  • each publish.play.service_account, and each ${{ secrets.NAME }} reference in a step command, target build command or env value, against the secrets the build could see: the project’s (GET /v1/projects/{project_id}/secrets), the pipeline’s with --pipeline, and the instance’s when the session may list them. A reference the build cannot resolve would fail it when it starts.

Each name that fails is an error: line on standard error, and the command exits non-zero:

oore pipeline validate .oore.yaml --project proj_123
error: workflows.adhoc.signing.ios names signing identity 'coin-adhoc', which project proj_123 does not have; add it under Project settings > Signing
error: workflow release uploads to App Store Connect, but workflows.release.signing.ios names 'coin-app-store', which holds ad hoc profiles; use an identity with App Store profiles
error: env.SENTRY_DSN names secret 'SENTRY_DSN', which is not a project, pipeline or instance secret
Error: .oore.yaml has 3 credential errors against project proj_123

When every name exists it prints:

.oore.yaml is valid; checked 3 signing identities and 1 secret against project proj_123

A session that may not list instance secrets, such as a project developer’s, cannot tell whether a secret missing from the project is an instance secret. That case is a note: line, not an error. Version 1 files name no signing identities, so only their ${{ secrets.NAME }} references are checked.

The check covers what the file names. A pipeline’s workflow settings can pick other identities when a build is created; the build checks those itself.

See .oore.yaml and .oore.yaml version 2 for the schemas, and oore pipeline plan to print the steps a file runs.