`oore pipeline plan`
Print the steps a repository pipeline file runs, per workflow and platform.
oore pipeline plan [PATH] [--workflow NAME] [--platform PLATFORM]... [--json]PATH defaults to .oore.yaml. The command validates the file like
oore pipeline validate, then prints
what a build runs: the step names, their commands after vars and flavor
references are resolved, the env and the artifact patterns. For version 2 it
also prints where each platform publishes, the signing identities the
workflow names, the iOS export, and the credentials each store upload uses.
It reads only the file and contacts no backend.
| Option | Effect |
|---|---|
--workflow NAME | Plan one version 2 workflow. Without it, every workflow is printed. |
--platform PLATFORM | Plan only android, ios or macos, as a run that selects them would. Repeat for several. |
--json | Print a JSON array with one plan per workflow. |
oore pipeline plan
oore pipeline plan --workflow release --platform android.oore.yaml (version 2)
workflow release
platforms: android
flutter: 3.24.5
env:
BUILD_FLAVOR=staging
SENTRY_DSN=${{ secrets.SENTRY_DSN }}
steps:
1. Get packages [pre_build]
$ flutter pub get
2. Build Android (pro) [build, android]
$ flutter build appbundle --release --flavor pro
artifacts:
build/app/outputs/bundle/proRelease/*.aab
publish:
android publishes to the Google Play production track to 1% of users with the draft setting from the pipeline's Google Play settings (targets.android.publish.play)
signing:
android: the pipeline's Android signing settings
store credentials:
google play: the service account secret in the pipeline's Google Play settings (targets.android.publish.play sets no service_account)
Signing and store credentials are what the file names. A pipeline's Workflows settings can pick other identities or turn publishing off.Signing and credentials
For each workflow, the version 2 plan adds:
| Line | Shows |
|---|---|
signing: | Per Android and iOS target, the identity the workflow names and the field that names it, such as workflows.release.signing.ios, or the pipeline’s signing settings when it names none |
ios export: | App Store when the workflow uploads to App Store Connect, with the identity that must hold App Store profiles. Otherwise the export follows the named identity’s profiles, or the pipeline’s iOS signing |
store credentials: | For Google Play, the service_account secret, or the pipeline’s Google Play settings. For App Store Connect, the API key in the pipeline’s iOS signing settings |
The plan shows what the file names. When a build is created, the pipeline’s
workflow settings
can replace an identity or turn publishing off, and the iOS export method
follows the profiles of the identity the build signs with: App Store or ad
hoc. Use oore pipeline validate --project
to check the names against the project.
For a workflow that names its credentials, such as release in
Run two workflows from one file, the lines
read:
signing:
android: identity upload-key (signing.android)
ios: identity coin-app-store (workflows.release.signing.ios)
ios export: App Store, because the workflow uploads to App Store Connect; identity coin-app-store must hold App Store profiles
store credentials:
google play: service account secret PLAY_SERVICE_ACCOUNT (workflows.release.targets.android.publish.play.service_account)
app store connect: the API key in the pipeline's iOS signing settingsSecret references are printed as written; the runner resolves them during the
build. A version 1 file prints the same plan the runner uses, including
Oore’s default flutter pub get and platform build commands, with steps named
pre_build-1, build-1 and so on. When a pipeline uploads to Google Play,
the runner also adds a flutter build appbundle step after a default Android
command; the printed plan leaves it out.
The pipeline editor’s What will run section shows the same plan from the
daemon, for the form’s settings or a pasted .oore.yaml, with the same errors.
It lists env keys without their values, and where the workflow publishes as a
note. The --json output has, per plan, a publish object with play,
testflight and app_store entries, and a signing object with the
android and ios identity names the workflow resolves to.