asc workflow

以下を使用して CLI 内でレーンスタイルの自動化が必要な場合にこのスキルを使用します:

• asc workflow validate
• asc workflow list
• asc workflow run

Workflow はリポジトリローカルな自動化ファイルです。信頼できるシェルコマンドを実行し、ステップ出力を stderr にストリーミングし、stdout はマシン可読な JSON として保持します。

コマンド検出

常にフラグを以下で確認してください:

asc workflow --help
asc workflow validate --help
asc workflow list --help
asc workflow run --help

エンドツーエンドフロー

1. .asc/workflow.json を作成します。
2. 構造と参照を検証します:

asc workflow validate

3. 公開ワークフローを検出します:

asc workflow list
asc workflow list --all

4. 実行をプレビューします:

asc workflow run --dry-run beta BUILD_ID:123456789 GROUP_ID:abcdef

5. 実行します:

asc workflow run beta BUILD_ID:123456789 GROUP_ID:abcdef

6. 復旧可能な実行が失敗した場合は、JSON 結果から取得した実行 ID で再開します:

asc workflow run release --resume "release-20260312T120000Z-deadbeef"

--resume を使用する場合は追加の KEY:VALUE パラメータを渡さないでください。保存されたワークフローファイル、パラメータ、永続化された出力が再利用されます。

ファイルの場所と形式

• デフォルトパス: .asc/workflow.json
• パスをオーバーライド: asc workflow run --file ./path/to/workflow.json <name>
• JSONC コメントはサポートされています。
• トップレベルフック: before_all, after_all, error
• Workflow キー: description, private, env, steps
• ステップの形式:
  • 文字列省略形: "echo hello"
  • run シェルコマンド
  • workflow サブワークフロー呼び出し
  • name ラベル
  • if 条件変数名
  • with ワークフロー呼び出しステップの環境変数オーバーライド
  • outputs JSON stdout から名前付き実行ステップを抽出するためのマップ

出力

実行ステップは出力を宣言できます。コマンドは stdout に JSON を出力する必要があるため、出力を生成する asc コマンドに対して --output json を渡してください。

出力参照は以下を使用します:

${steps.step_name.OUTPUT_NAME}

ルール:

• outputs を宣言するステップは参照安全な name を持つ必要があります。
• 出力は run ステップでは許可されていますが、ワークフロー呼び出しステップでは許可されていません。
• 出力生成名は、同じ実行グラフで一緒に実行できるワークフロー全体で一意である必要があります。
• 永続化された出力はワークフロー実行状態に保存されるため、シークレットを出力にマップしないでください。

ランタイムパラメータ

asc workflow run <name> [KEY:VALUE ...] は両方のセパレータをサポートします:

asc workflow run beta VERSION:2.1.0
asc workflow run beta VERSION=2.1.0

繰り返されたキーは最後の書き込みが勝ちます。シェルコマンドでは、$VERSION のようなシェル展開を通じてパラメータを参照します。

環境変数の優先順位

メインワークフロー実行:

definition.env < workflow.env < CLI params

with を使用したサブワークフロー呼び出し:

sub-workflow env < caller env and params < step with

条件付き

ステップに "if": "VAR_NAME" を追加します。真実の値は 1、true、yes、y、および on です (大文字小文字は区別されません)。参照チェックでは、マージされたワークフロー環境/パラメータを最初に確認し、次にプロセス環境を確認します。

ワークフロー例

{
  "env": {
    "APP_ID": "123456789",
    "VERSION": "1.0.0",
    "GROUP_ID": ""
  },
  "before_all": "asc auth status",
  "after_all": "echo workflow_done",
  "error": "echo workflow_failed",
  "workflows": {
    "beta": {
      "description": "Resolve the latest build and distribute it to TestFlight",
      "steps": [
        {
          "name": "resolve_build",
          "run": "asc builds info --app $APP_ID --latest --platform IOS --output json",
          "outputs": {
            "BUILD_ID": "$.data.id"
          }
        },
        {
          "name": "list_groups",
          "run": "asc testflight groups list --app $APP_ID --limit 20 --output json"
        },
        {
          "name": "add_build_to_group",
          "if": "GROUP_ID",
          "run": "asc builds add-groups --build-id ${steps.resolve_build.BUILD_ID} --group $GROUP_ID"
        }
      ]
    },
    "release": {
      "description": "Validate, stage, and submit an App Store version",
      "steps": [
        {
          "name": "validate",
          "run": "asc validate --app $APP_ID --version $VERSION --platform IOS --output json"
        },
        {
          "name": "stage",
          "run": "asc release stage --app $APP_ID --version $VERSION --build $BUILD_ID --metadata-dir ./metadata/version/$VERSION --confirm --output json"
        },
        {
          "name": "submit",
          "if": "SUBMIT_FOR_REVIEW",
          "run": "asc review submit --app $APP_ID --version $VERSION --build $BUILD_ID --confirm --output json"
        }
      ]
    },
    "publish-appstore": {
      "description": "High-level upload plus App Store review submission",
      "steps": [
        {
          "name": "publish",
          "run": "asc publish appstore --app $APP_ID --ipa ./build/MyApp.ipa --version $VERSION --wait --submit --confirm --output json"
        }
      ]
    }
  }
}

有用な実行例

asc workflow validate | jq -e '.valid == true'
asc workflow list --pretty
asc workflow list --all --pretty
asc workflow run --dry-run beta BUILD_ID:123 GROUP_ID:grp_abc
asc workflow run beta BUILD_ID:123 GROUP_ID:grp_abc | jq -e '.status == "ok"'
asc workflow run release BUILD_ID:123 SUBMIT_FOR_REVIEW:true
asc workflow run release --resume "release-20260312T120000Z-deadbeef"

安全ルール

• .asc/workflow.json をコードのように扱い、信頼できるワークフローファイルのみを実行します。
• 信頼できない PR からシークレットを使用してワークフローを実行することを避けます。
• ワークフローファイルをバージョン管理に保持します。
• 最初に検証し、次にドライラン、その後に実行します。
• 変更ステップの明示的な ID と --confirm を使用します。
• asc validate、asc release stage、asc review submit、および asc publish appstore を使用します。削除された送信コマンドは使用しないでください。