fix(CI): unblock Release workflow documentation job on main pushes by dlabaj · Pull Request #12511 · patternfly/patternfly-react

dlabaj · 2026-06-23T18:20:22Z

Summary

Skip the check-permissions job on workflow_call events (Release pushes to main), since the org check-team-membership reusable workflow only runs for PR preview events
Update the deploy job condition to use always() && !cancelled() so it still runs when check-permissions is skipped, unblocking the Release workflow's Deploy release job and NPM publishes

Fixes the skipped Documentation and Deploy release jobs seen in Release run #3125.

Test plan

Merge this PR and verify the next push to main runs Documentation / Build, test & deploy and Deploy release instead of skipping them
Open a PR from a non-team member and confirm documentation preview deploy is still gated behind the team membership check
Comment /deploy-preview on a PR from a team member and confirm preview deploy still works

Made with Cursor

Summary by CodeRabbit

Chores
- Updated the continuous integration/deployment workflow to make deployment eligibility checks more robust, adding additional execution safeguards to better prevent unintended or incomplete deployments.

Skip the PR-only team membership check for workflow_call runs and allow the deploy job to proceed when that dependency is skipped, so Release can deploy to NPM again. Co-authored-by: Cursor <cursoragent@cursor.com>

coderabbitai · 2026-06-23T18:20:48Z

Walkthrough

The documentation workflow's deploy job condition is expanded to a multi-line expression requiring always() && !cancelled() in addition to the prior workflow_call or permission output checks. A single line is inserted near the actions/checkout@v4 step in the workflow.

Changes

Documentation Workflow Job Conditions

Layer / File(s)	Summary
`deploy` job condition and step insertion `.github/workflows/documentation.yml`	`deploy` job's `if` condition is rewritten into a multi-line block with `always() && !cancelled()` guarding the prior `workflow_call` / `needs.check-permissions.outputs.allowed == 'true'` logic. A line is inserted at line 44 within the step area near `actions/checkout@v4`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

patternfly/patternfly-react#12385: Both PRs modify .github/workflows/documentation.yml specifically the deploy job gating/conditional execution logic.

Suggested reviewers

wise-king-sullyman

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main fix: unblocking the Release workflow's documentation job on main branch pushes by addressing the CI condition issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch fix/release-docs-workflow

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

patternfly-build · 2026-06-23T18:24:33Z

Preview: https://pf-react-pr-12511.surge.sh

A11y report: https://pf-react-pr-12511-a11y.surge.sh

kmcfaul · 2026-06-23T18:51:07Z

        required: true
 jobs:
  check-permissions:
+    if: github.event_name != 'workflow_call'


I might be misunderstanding since I'm not 100% on github actions, but this shouldn't be needed right? The subsequent always() + github.event_name == 'workflow_call' logic in the deploy step seems like it would allow a workflow call to bypass the failed the check-permissions step.

If it is needed, what does this line do? Short-circuit the check-team-membership.yml if it's a workflow_call?

Removed the line

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/documentation.yml:
- Line 44: A stray character `e` exists on line 44 of the documentation.yml
workflow file which breaks YAML parsing and prevents all workflow jobs from
executing. Remove this errant `e` character from line 44 to restore valid YAML
syntax and allow the workflow to parse correctly so the deploy job can run.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fc50b33c-5f8c-45a5-abc7-c076f7e5bb18

📥 Commits

Reviewing files that changed from the base of the PR and between 06cb39c and bcf961c.

📒 Files selected for processing (1)

.github/workflows/documentation.yml

coderabbitai · 2026-06-23T20:02:18Z

        if: github.event_name == 'workflow_call'
        uses: actions/checkout@v4
-
+e


🩺 Stability & Availability | 🔴 Critical | ⚡ Quick win

Remove the stray e — it breaks YAML parsing for the entire workflow.

This errant token is invalid YAML and will cause the workflow file to fail parsing, preventing all jobs (including deploy) from running. This is confirmed by the actionlint failure (could not find expected ':') and directly defeats this PR's goal of unblocking the Documentation/Deploy release jobs.

🐛 Proposed fix

-e

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

e

🧰 Tools

🪛 actionlint (1.7.12)

[error] 44-44: could not parse as YAML: could not find expected ':'

(syntax-check)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/documentation.yml at line 44, A stray character `e` exists on line 44 of the documentation.yml workflow file which breaks YAML parsing and prevents all workflow jobs from executing. Remove this errant `e` character from line 44 to restore valid YAML syntax and allow the workflow to parse correctly so the deploy job can run.

Source: Linters/SAST tools

kmcfaul · 2026-06-23T20:22:49Z

Just needs the stray e removed I think. LGTM

fix(CI): unblock Release workflow documentation job on main pushes

06cb39c

Skip the PR-only team membership check for workflow_call runs and allow the deploy job to proceed when that dependency is skipped, so Release can deploy to NPM again. Co-authored-by: Cursor <cursoragent@cursor.com>

dlabaj requested a review from thatblindgeye June 23, 2026 18:22

thatblindgeye approved these changes Jun 23, 2026

View reviewed changes

kmcfaul reviewed Jun 23, 2026

View reviewed changes

fix: updated with review comments.

bcf961c

coderabbitai Bot reviewed Jun 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(CI): unblock Release workflow documentation job on main pushes#12511

fix(CI): unblock Release workflow documentation job on main pushes#12511
dlabaj wants to merge 2 commits into
mainfrom
fix/release-docs-workflow

dlabaj commented Jun 23, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 23, 2026 •

edited

Loading

Uh oh!

patternfly-build commented Jun 23, 2026 •

edited

Loading

Uh oh!

kmcfaul Jun 23, 2026

Uh oh!

dlabaj Jun 23, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jun 23, 2026

Uh oh!

kmcfaul commented Jun 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

dlabaj commented Jun 23, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

patternfly-build commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kmcfaul Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

dlabaj Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

kmcfaul commented Jun 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dlabaj commented Jun 23, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 23, 2026 •

edited

Loading

patternfly-build commented Jun 23, 2026 •

edited

Loading