Skip to content

Harden check-doc-impact against cross-repo auth failures#541

Merged
dan2k3k4 merged 2 commits into
mainfrom
copilot/fix-check-doc-impact
Jun 2, 2026
Merged

Harden check-doc-impact against cross-repo auth failures#541
dan2k3k4 merged 2 commits into
mainfrom
copilot/fix-check-doc-impact

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 1, 2026

check-doc-impact was failing when the docs issue creation call to amazeeio/docs.amazee.ai hit org SAML enforcement on the token. This caused a non-critical notification step to fail the entire job.

  • Root cause

    • gh issue list/create in the Open docs issue step can fail due to external token authorization (SAML), even when PR doc-impact detection is correct.
  • Change

    • Marked the Open docs issue step as non-blocking with continue-on-error: true.
    • Preserves doc-impact detection and draft generation behavior; only suppresses hard-fail semantics for cross-repo issue publication.
  • Workflow behavior after change

    • Doc-impact checks still run and evaluate matches.
    • If docs issue creation is unauthorized/transiently unavailable, the job completes instead of failing.
- name: Open docs issue
  if: steps.check.outputs.has_matches == 'true'
  continue-on-error: true
  env:
    GH_TOKEN: ${{ secrets.DOCS_ISSUE_TOKEN }}

Greptile Summary

This PR adds continue-on-error: true to the Open docs issue step in doc-check.yml, making cross-repo issue creation non-blocking when the DOCS_ISSUE_TOKEN is rejected by org SAML enforcement.

  • The doc-impact detection, diff fetch, and AI draft generation steps are unchanged and still gate on has_matches == 'true'; only the final gh issue create call against amazeeio/docs.amazee.ai is made fault-tolerant.
  • One subtle behaviour worth noting: the duplicate-check (gh issue list) runs inside the same step and with the same token. If the token is unauthorized, gh issue list fails first (with set -e / pipefail active), EXISTING stays empty, and the step exits before gh issue create is reached — continue-on-error catches the whole-step failure cleanly and the job proceeds.

Confidence Score: 5/5

Safe to merge. The change is a single-line addition to a non-critical notification step and does not affect doc-impact detection or any application code.

The added continue-on-error: true is correctly scoped to the cross-repo issue creation step only. All earlier steps — detection, diff fetch, and LLM draft — remain blocking and unchanged. Failures in the issue step will still appear as warnings in the Actions UI, so they are not invisible. No logic was altered and there is no risk to the repo's main workflows.

No files require special attention.

Important Files Changed

Filename Overview
.github/workflows/doc-check.yml Single-line addition of continue-on-error: true to the Open docs issue step; all other steps and logic are untouched. The change correctly scopes fault-tolerance to the cross-repo notification step only.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([PR merged to main/dev]) --> B[Get changed files]
    B --> C{Doc-impacting\nfiles changed?}
    C -- No --> D([Job succeeds — no action])
    C -- Yes --> E[Fetch PR diff]
    E --> F[Draft doc update via amazee.ai LLM]
    F --> G[Open docs issue\ncontinue-on-error: true]
    G -- Success --> H([Issue created in\namazeeio/docs.amazee.ai])
    G -- SAML / auth failure --> I([Step marked as\nwarning — job still succeeds])
    G -- Issue already exists --> J([Skipped — exit 0])
Loading

Reviews (1): Last reviewed commit: "Handle doc issue creation failures in do..." | Re-trigger Greptile

Copilot AI changed the title [WIP] Fix failing GitHub Actions job check-doc-impact Harden check-doc-impact against cross-repo auth failures Jun 1, 2026
Copilot AI requested a review from dan2k3k4 June 1, 2026 18:52
@dan2k3k4 dan2k3k4 marked this pull request as ready for review June 2, 2026 04:49
@dan2k3k4 dan2k3k4 requested a review from dspachos June 2, 2026 04:50
@dan2k3k4 dan2k3k4 merged commit df64fa6 into main Jun 2, 2026
4 checks passed
@dan2k3k4 dan2k3k4 deleted the copilot/fix-check-doc-impact branch June 2, 2026 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants