Skip to content

Workflow fails on first-time setup but error message says 'this is normal, ignore it' #722

Description

@TimEvans

Description

When adding the Claude workflow to a repository for the first time, the workflow fails with exit code 1 and shows as ❌ FAILED in GitHub's UI. However, the error message buried in the logs says "this is normal and you should ignore this error."

This creates a contradictory user experience that blocks users from merging their initial setup PR.

Steps to Reproduce

  1. Run /install-github-app in Claude Code CLI
  2. Create a PR with the generated workflow files
  3. Workflow runs and fails with:
##[error]Failed to setup GitHub token: Error: Workflow validation failed.
The workflow file must exist and have identical content to the version on
the repository's default branch. If you're seeing this on a PR when you
first add a code review workflow file to your repository, this is normal
and you should ignore this error.

The Problem

What the user sees in GitHub UI:

  • ❌ FAILED (red X, exit code 1)
  • No indication this is expected behavior

What's hidden in the failed workflow logs (only visible if you click through and read the output):

Failed to setup GitHub token: Error: Workflow validation failed. The workflow
file must exist and have identical content to the version on the repository's
default branch. If you're seeing this on a PR when you first add a code review
workflow file to your repository, this is normal and you should ignore this error.

If you instead wish to use this action with a custom GitHub token or custom
GitHub app, provide a github_token in the uses section of the app in your
workflow yml file.

The failure status directly contradicts the buried message telling users to ignore it. Most users won't dig into failed workflow logs to find this explanation.

What Actually Happens

The workflow needs to be on the default branch before GitHub App auth can validate it (security feature). So the first PR will always fail, but it works after merging.

I only discovered this after multiple reinstalls and debugging. I specifically didn't merge the PR because the workflow was failing - which to be fair is the correct response to a failing workflow!

Suggested Fix

If this failure is expected for first-time setup, the workflow should NOT fail. Options:

  1. Pass with a warning: Show ✅ success with a warning annotation: "First-time workflow setup detected. Workflow will activate after PR is merged to main."
  2. Skip the run: Don't run the workflow on PRs that add it for the first time.
  3. Different status: Use a status that isn't "failed" (maybe neutral/skipped).

Impact

Users see "failed" and reasonably assume something is wrong, blocking them from completing the setup. The "this is normal" explanation is hidden in logs that users won't check.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions