Skip to content

Relax preview-docs workflow trigger to run on any completion#19115

Merged
harupy merged 2 commits intomasterfrom
copilot/update-preview-docs-trigger
Nov 30, 2025
Merged

Relax preview-docs workflow trigger to run on any completion#19115
harupy merged 2 commits intomasterfrom
copilot/update-preview-docs-trigger

Conversation

Copy link
Contributor

Copilot AI commented Nov 30, 2025

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

The preview-docs.yml workflow previously only triggered when docs.yml completed successfully. This blocked preview deployments when unrelated jobs failed (e.g., lint checks), slowing the feedback loop.

Changes:

  • Remove github.event.workflow_run.conclusion == 'success' condition from preview-docs workflow
  • Workflow now triggers on any completion (success, failure, or cancelled)

Behavior:

  • Lint fails, build succeeds → preview deploys (new)
  • Build fails → preview workflow fails gracefully when downloading artifacts (acceptable)
  • Both succeed → preview deploys (unchanged)

Since check and build jobs in docs.yml run independently, lint failures won't prevent successful builds from being previewed.

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Validated YAML syntax with yamllint. The workflow behavior will be verified on the next PR that triggers docs.yml.

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)
Original prompt

preview-docs.yml is currently triggered only when docs.yml finishes successfully. Relax this condition so it triggers whenever docs.yml completes. For example, a lint failure shouldn’t block a preview deploy, since it slows down the feedback loop. This change may cause an error when downloading the alias file, but that’s acceptable.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@harupy harupy marked this pull request as ready for review November 30, 2025 00:58
Remove the success condition from preview-docs.yml so it triggers whenever docs.yml completes, regardless of success or failure. This allows previews to deploy even when lint checks fail, improving the feedback loop. The workflow will gracefully fail if build artifacts are not available.

Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot AI changed the title [WIP] Update preview-docs.yml trigger conditions Relax preview-docs workflow trigger to run on any completion Nov 30, 2025
Copilot AI requested a review from harupy November 30, 2025 01:03
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Nov 30, 2025
@harupy harupy added this pull request to the merge queue Nov 30, 2025
Merged via the queue into master with commit 67b6011 Nov 30, 2025
53 of 72 checks passed
@harupy harupy deleted the copilot/update-preview-docs-trigger branch November 30, 2025 03:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rn/none List under Small Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants