GitHub Actions ↔ GitHub REST API: Is an atomic rollback after a schema change documented?

Answer to the Question

GitHub has no documented REST API endpoint that atomically undoes every side‑effect of a completed workflow run, including commits, artifacts, deployments, or external database schema changes. The only API operations that exist are workflow_dispatch, cancel, rerun, and ref manipulation, none of which invert a finished run.

What You Can Do Now

1. Record pre‑change state: In the workflow that applies the schema change, capture the commit SHA, migration version, and any external snapshots (e.g., database dump) into a hidden file or a dedicated PR comment.
2. Create a rollback workflow: Triggered by workflow_dispatch or by a comment, this workflow checks out the recorded SHA, restores the repository to that state, and pushes it back to the target branch. Use git push --force-with-lease or the PATCH /repos/{owner}/{repo}/git/refs/{ref} endpoint to update the branch atomically. If branch protection is enabled, prefer creating a “revert” commit instead of a force‑push.
3. Compensate external systems: For database schema changes, write a down‑migration or a compensating script that restores the previous schema state. Run this script as part of the rollback workflow or as a separate job that is idempotent.
4. Use community Actions: actions/checkout@v3 for checkout, actions/github-script for API calls, and actions/checkout@v3 with the fetch-depth option set to 0 to preserve full history. No Action currently performs an “undo” of a workflow run.

Why There’s No Atomic Rollback

GitHub treats a workflow run as an execution record separate from Git history. The Git history itself is immutable once pushed; there is no run‑journal that can be replayed in reverse. External state changes (e.g., database migrations) are beyond Git’s scope, so even a perfect Git revert cannot guarantee a clean rollback.

Missing Diagnostic Detail

Does the schema change affect only files in the repository, or does it modify an external database or service? Knowing this determines whether a Git‑only rollback suffices or if you must also run a compensating migration.