From 74129f6d753ad94aeb43a0b587b073b0c0252a03 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Mon, 22 Sep 2025 09:56:18 -0500 Subject: [PATCH] add docs on CI workflow inputs --- .github/workflows/build.yaml | 6 ++++++ .github/workflows/test.yaml | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 7b5f430dfa..933d8aa985 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -24,15 +24,21 @@ on: workflow_dispatch: inputs: branch: + description: | + branch: git branch the workflow run targets. + Required even when 'sha' is provided because it is also used for organizing artifacts. required: true type: string date: + description: "date: Date (YYYY-MM-DD) this run is for. Used to organize artifacts produced by nightly builds" required: true type: string sha: + description: "sha: full git commit SHA to check out" required: true type: string build_type: + description: "build_type: one of [branch, nightly, pull-request]" type: string default: nightly diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 080d81a7ae..7b4bbd95cf 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -19,15 +19,21 @@ on: workflow_dispatch: inputs: branch: + description: | + branch: git branch the workflow run targets. + Required even when 'sha' is provided because it is also used for organizing artifacts. required: true type: string date: + description: "date: Date (YYYY-MM-DD) this run is for. Used to organize artifacts produced by nightly builds" required: true type: string sha: + description: "sha: full git commit SHA to check out" required: true type: string build_type: + description: "build_type: one of [branch, nightly, pull-request]" type: string default: nightly