add-debug-wait

Name

ci:add-debug-wait

Synopsis

/ci:add-debug-wait <workflow-or-job-name> [timeout]

Description

The ci:add-debug-wait command adds a wait step to a CI job/workflow for debugging test failures.

What it does:

1. Takes job name, OCP version, and optional timeout as input
2. Finds and edits the job config or workflow file
3. Adds - ref: wait before the last test step (with optional timeout configuration)
4. Creates a git commit
5. Pushes the commit to your fork (origin remote)
6. Creates a PR via gh

That's it! Simple, fast, and automated.

Implementation

The command performs the following steps:

Step 1: Gather Required Information

Prompt user for (in this order):

1. Workflow/Job Name: (from command argument $1 or prompt)

   Workflow or job name: <user-input>
   Example: aws-c2s-ipi-disc-priv-fips-f7
   Example: baremetalds-two-node-arbiter-e2e-openshift-test-private-tests
   

2. Timeout (optional, from command argument $2):

   Wait timeout in hours (optional, default: 3h):
   Examples: "1h", "2h", "8h", "24h", "72h"
   Valid range: 1h to 72h
   

   • If not provided, uses the wait step's default behavior (3 hours)
   • Format: Integer followed by 'h' (e.g., "1h", "2h", "8h")
   • Valid range: 1h to 72h (maximum enforced by wait step's timeout setting)
   • For job config files (ci-operator/config/): Set as the TIMEOUT env var (e.g., TIMEOUT: +8 hours) in the job's env: section
   • For workflow files (ci-operator/step-registry/): Set as timeout: (normalized to Go duration format, e.g., "8h" → "8h0m0s") and best_effort: true properties on the ref step

3. OCP Version: (prompt - REQUIRED for searching job configs)

   OCP version for debugging (e.g., 4.18, 4.19, 4.20, 4.21, 4.22):
   

   This is used to:

   • Search the correct job config file (e.g., release-4.21)
   • Document which version needs debugging
   • Add context to the PR

4. OpenShift Release Repo Path: (prompt if not in current directory)

   Path to openshift/release repository:
   Default: ~/repos/openshift-release