Adding docs-preview workflow, Canary release PR comments by kharrop · Pull Request #720 · player-ui/player

kharrop · 2025-09-12T15:58:03Z

/canary

---
config:
  look: classic
  layout: dagre
---
flowchart LR
    n1["setup"] --> n2["bazelrc"]
    n2 --> n3["build-trunk"] & n10["build-ios-trunk"]
    n3 --> n4["test-trunk"] & n8["js-benchmark-tests-trunk"] & n9["android-test-trunk"] & n10 & n6["maybe release"] & n11["coverage-trunk"]
    n4 --> n5["build + preview docs"]
    n10 --> n6 & n11
    n9 --> n6
    n1@{ shape: rect}

/release

---
config:
  look: classic
  layout: dagre
---
flowchart LR
    n12["setup"] --> n13["bazelrc"]
    n13 --> n14["build"]
    n14 --> n15["build_ios"] & n17["android_test"] & n16["coverage"]
    n15 --> n16 & n18["release (+ docs)"]
    n17 --> n18
    n16 --> n18
    n19["build_docs"] --> n18
    n16 --> n19
    n12@{ shape: rect}
    n13@{ shape: rect}
    n14@{ shape: rect}

Comment examples:

PR Comment triggered by /docs:

PR Comment triggered by /canary (replaces previous docs comment if present):

Change Type (required)

Indicate the type of change your pull request is:

patch
minor
major
N/A

Does your PR have any documentation updates?

Updated docs
No Update needed
Unable to update docs

Release Notes

This PR contains a few docs-related quality of life improvements, details below:

Adds a pr-comment workflow that supports command-triggered PR comments - including: /canary, /docs
Adds a docs preview workflow that is triggered when a collaborator adds a comment including /docs, similar to our /canary workflow. This workflow will push static docs files to https://github.com/player-ui/player-ui.github.io and publish a URL that includes PR docs changes.
Adds a pr-closed workflow that will run when a PR is either closed manually or merged, which will automatically clean up the pr folder in the https://github.com/player-ui/player-ui.github.io. This workflow can be expanded on in the future if needed.
Adds a PR comment that includes Canary release information after the "/canary" workflow is done and a new release becomes available, making it more clear to users which version is tied to when the command was run.
Updated full release job to be dependent on docs build success
Updated maybe_release to depend on android tests as well

📦 Published PR as canary version: 0.14.1--canary.720.28165

Try this version out locally by upgrading relevant packages to 0.14.1--canary.720.28165

codecov · 2025-09-12T16:30:27Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.77%. Comparing base (2f41161) to head (40a7649).
⚠️ Report is 102 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #720   +/-   ##
=======================================
  Coverage   85.77%   85.77%           
=======================================
  Files         504      504           
  Lines       22669    22669           
  Branches     2639     2639           
=======================================
+ Hits        19444    19445    +1     
+ Misses       2896     2895    -1     
  Partials      329      329

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

kharrop · 2025-09-12T19:49:41Z

/canary

…to docs-preview

kharrop · 2025-09-13T03:04:26Z

/canary

kharrop · 2025-09-13T03:57:20Z

/canary

kharrop · 2025-09-13T04:15:18Z

/canary

kharrop · 2025-09-14T02:20:59Z

/canary

intuit-svc · 2025-10-14T22:31:04Z

Build Preview

Your PR was deployed by CircleCI #28084 on Tue, 14 Oct 2025 22:31:03 GMT with this version:

0.14.1--canary.720.28084

📖 Docs (View site)

kharrop · 2025-10-15T16:41:39Z

/canary

intuit-svc · 2025-10-15T17:05:27Z

Build Preview

Your PR was deployed by CircleCI #28105 on Wed, 15 Oct 2025 17:05:26 GMT with this version:

0.14.1--canary.720.28105

📖 Docs (View site)

kharrop · 2025-10-15T18:01:55Z

/canary

intuit-svc · 2025-10-15T18:24:55Z

Build Preview

Your PR was deployed by CircleCI #28126 on Wed, 15 Oct 2025 18:24:54 GMT with this version:

0.14.1--canary.720.28126

📖 Docs (View site)

kharrop · 2025-10-15T19:27:04Z

/canary

intuit-svc · 2025-10-15T19:52:23Z

Build Preview

Your PR was deployed by CircleCI #28145 on Wed, 15 Oct 2025 19:52:21 GMT with this version:

0.14.1--canary.720.28145

📖 Docs (View site)

kharrop · 2025-10-15T20:42:16Z

/canary

intuit-svc · 2025-10-15T21:05:56Z

Build Preview

Your PR was deployed by CircleCI #28165 on Wed, 15 Oct 2025 21:05:56 GMT with this version:

0.14.1--canary.720.28165

📖 Docs (View site)

KVSRoyal · 2025-10-16T18:55:15Z

            - auto_shipit

+  build_and_deploy_docs_preview:
+    executor: benchmarks


Curiosity question: why the benchmarks executor instead of a different executor?

It uses fewer resources and since this is just for docs, it doesn't need as much.

KVSRoyal · 2025-10-16T19:04:54Z

      variant: minimal
 ---

+/\*_ Known issue: Actions in the hero section do not work when running in Preview mode _/


What is the "hero" section?

player/docs/site/src/content/docs/index.mdx

Line 5 in 95e890b

hero:

…preview

sugarmanz · 2025-10-23T18:57:09Z

Will close #52

kharrop added 3 commits September 12, 2025 10:57

WIP workflow docs setup

d032974

trying to fix config

6ba3766

trying to fix config

411267c

sugarmanz reviewed Sep 12, 2025

View reviewed changes

Comment thread .circleci/config.yml Outdated

sugarmanz reviewed Sep 12, 2025

View reviewed changes

Comment thread .circleci/config.yml Outdated

sugarmanz reviewed Sep 12, 2025

View reviewed changes

Comment thread scripts/deploy-canary-docs.sh Outdated

kharrop changed the title ~~[WIP] Adding docs preview functionality~~ [DO NOT REVIEW] Adding docs preview functionality Sep 12, 2025

kharrop and others added 2 commits September 12, 2025 14:15

using release.sh to deploy canary folder - testing

2d8e8da

Merge branch 'main' into docs-preview

6f725c3

player-ui deleted a comment from intuit-svc Sep 12, 2025

kharrop added 2 commits September 12, 2025 22:03

trying to fix errors and also add algolia to canary logic

ab633b8

Merge branch 'docs-preview' of https://github.com/player-ui/player in…

a5265c8

…to docs-preview

kharrop closed this Sep 13, 2025

kharrop reopened this Sep 13, 2025

updating pr comment message

3365960

kharrop added 2 commits September 12, 2025 23:14

Fix VERSION file format to match upstream/main

722ad63

adding a title

39e5158

kharrop added 6 commits September 13, 2025 08:15

updating trigger logic

fd8f436

trying to fix gh action

82028cf

Updating comments logic

2d9751c

Updating release comment content

78a445c

Updating message

20e8135

testing docs comment

79fadb5

player-ui deleted a comment from github-actions Bot Sep 14, 2025

testing new docs flow

52c4a75

intuit-svc added a commit to player-ui/player-ui.github.io that referenced this pull request Oct 15, 2025

Deploying docs for player-ui/player#720

017c989

fixing double slash

dc825df

intuit-svc added a commit to player-ui/player-ui.github.io that referenced this pull request Oct 15, 2025

Deploying docs for player-ui/player#720

4c4cc13

fixing double slash

20d6d31

intuit-svc added a commit to player-ui/player-ui.github.io that referenced this pull request Oct 15, 2025

Deploying docs for player-ui/player#720

504fa91

fixing double slash

95e890b

intuit-svc added a commit to player-ui/player-ui.github.io that referenced this pull request Oct 15, 2025

Deploying docs for player-ui/player#720

1845699

KVSRoyal reviewed Oct 16, 2025

View reviewed changes

KVSRoyal previously approved these changes Oct 16, 2025

View reviewed changes

updating based on release playround insights

f51bced

kharrop dismissed KVSRoyal’s stale review via f51bced October 21, 2025 14:54

kharrop added 2 commits October 21, 2025 09:54

Merge branch 'main' of https://github.com/player-ui/player into docs-…

9be93b6

…preview

reverting ios resource class change

6e00245

KetanReddy approved these changes Oct 27, 2025

View reviewed changes

sugarmanz approved these changes Oct 27, 2025

View reviewed changes

Merge branch 'main' into docs-preview

40a7649

kharrop merged commit 7fe3976 into main Oct 28, 2025
13 checks passed

kharrop mentioned this pull request Oct 29, 2025

Still publish docs during auto release with documentation label #52

Closed

KetanReddy deleted the docs-preview branch November 13, 2025 19:49

Conversation

kharrop commented Sep 12, 2025 • edited by intuit-svc Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment examples:

Change Type (required)

Does your PR have any documentation updates?

Release Notes

Uh oh!

codecov Bot commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kharrop commented Sep 12, 2025

Uh oh!

kharrop commented Sep 13, 2025

Uh oh!

kharrop commented Sep 13, 2025

Uh oh!

kharrop commented Sep 13, 2025

Uh oh!

kharrop commented Sep 14, 2025

Uh oh!

intuit-svc commented Oct 14, 2025

Build Preview

📖 Docs (View site)

Uh oh!

kharrop commented Oct 15, 2025

Uh oh!

intuit-svc commented Oct 15, 2025

Build Preview

📖 Docs (View site)

Uh oh!

kharrop commented Oct 15, 2025

Uh oh!

intuit-svc commented Oct 15, 2025

Build Preview

📖 Docs (View site)

Uh oh!

kharrop commented Oct 15, 2025

Uh oh!

intuit-svc commented Oct 15, 2025

Build Preview

📖 Docs (View site)

Uh oh!

kharrop commented Oct 15, 2025

Uh oh!

intuit-svc commented Oct 15, 2025

Build Preview

📖 Docs (View site)

Uh oh!

KVSRoyal Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

kharrop Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

KVSRoyal Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

kharrop Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

sugarmanz commented Oct 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kharrop commented Sep 12, 2025 •

edited by intuit-svc

Loading

codecov Bot commented Sep 12, 2025 •

edited

Loading