Skip to content

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

Merged
thatblindgeye merged 3 commits into
mainfrom
fix/release-docs-workflow
Jun 24, 2026
Merged

fix(CI): unblock Release workflow documentation job on main pushes#12511
thatblindgeye merged 3 commits into
mainfrom
fix/release-docs-workflow

Conversation

@dlabaj

@dlabaj dlabaj commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

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 strengthen deployment eligibility checks, adding additional execution safeguards to help 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

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f929f5bf-a195-4784-b958-c944c6af1131

📥 Commits

Reviewing files that changed from the base of the PR and between bcf961c and 87f0f34.

📒 Files selected for processing (1)
  • .github/workflows/documentation.yml
💤 Files with no reviewable changes (1)
  • .github/workflows/documentation.yml

Walkthrough

The documentation workflow's deploy job condition is expanded to require always() && !cancelled() in addition to the existing workflow_call or permission-output checks.

Changes

Documentation Workflow Job Conditions

Layer / File(s) Summary
deploy job condition update
.github/workflows/documentation.yml
deploy job's if condition is rewritten into a multi-line expression with always() && !cancelled() guarding the prior trigger and permission checks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

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 reflects the CI workflow fix that unblocks the documentation job on main pushes.
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.

@dlabaj dlabaj requested a review from thatblindgeye June 23, 2026 18:22
@patternfly-build

patternfly-build commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Comment thread .github/workflows/documentation.yml Outdated
required: true
jobs:
check-permissions:
if: github.event_name != 'workflow_call'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the line

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread .github/workflows/documentation.yml Outdated
@kmcfaul

kmcfaul commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Just needs the stray e removed I think. LGTM

Comment thread .github/workflows/documentation.yml Outdated
@dlabaj

dlabaj commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

@kmcfaul @thatblindgeye All set now. Thanks

@thatblindgeye thatblindgeye merged commit 66767e6 into main Jun 24, 2026
15 checks passed
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.

4 participants