chore(ci): link Unity Cloud builds, test reports, timings, performance and automation from the CI status comment #9713
+1,981
−205
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| name: Fetch Unity Cloud Build Links | ||
| description: >- | ||
| Download the unity_build_info_* artifacts of a Unity Cloud Build run and emit | ||
| sanitized markdown linking each build id to its Unity Cloud dashboard page: | ||
| bare table rows for appending to an existing two-column table, and a standalone | ||
| table section for comment bodies that have no table of their own. | ||
|
|
||
| inputs: | ||
| run-id: | ||
| description: Workflow run id of the Unity Cloud Build run whose artifacts to read. | ||
| required: true | ||
| github-token: | ||
| description: Token used to download the run's artifacts. | ||
| required: true | ||
|
|
||
| outputs: | ||
| rows: | ||
| description: >- | ||
| "| Name | Link |"-shaped rows for an existing two-column table; empty when | ||
| no valid build info was found. | ||
| value: ${{ steps.fetch.outputs.rows }} | ||
| section: | ||
| description: >- | ||
| Standalone table (header + rows); empty when no valid build info was found. | ||
| value: ${{ steps.fetch.outputs.section }} | ||
|
|
||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Download and sanitize Unity Cloud build info | ||
| id: fetch | ||
| shell: bash | ||
| env: | ||
| GH_TOKEN: ${{ inputs.github-token }} | ||
| RUN_ID: ${{ inputs.run-id }} | ||
| REPO_FULL: ${{ github.repository }} | ||
| run: | | ||
| set -euo pipefail | ||
|
|
||
| # The info files come out of the PR-controlled build workflow, so treat them as | ||
| # untrusted input: accept only a numeric build id and a Unity dashboard URL with | ||
| # a conservative charset before letting them anywhere near a comment body. | ||
| URL_RE='^https://(cloud\.unity\.com|developer\.cloud\.unity3d\.com|dashboard\.unity3d\.com)/[A-Za-z0-9./_%~?=&#-]*$' | ||
| parse_info() { | ||
| local target="$1" | ||
| local dir="ucb_info_${target}" | ||
| REPLY_ID="" | ||
| REPLY_URL="" | ||
| if gh run download "$RUN_ID" \ | ||
| --repo "$REPO_FULL" \ | ||
| --name "unity_build_info_${target}_launcher" \ | ||
| --dir "$dir" 2>"${dir}.err"; then | ||
| REPLY_ID=$(grep -m1 '^BUILD_ID=' "$dir/unity_cloud_build_info.env" | cut -d= -f2- || true) | ||
| REPLY_URL=$(grep -m1 '^DASHBOARD_URL=' "$dir/unity_cloud_build_info.env" | cut -d= -f2- || true) | ||
| [[ "$REPLY_ID" =~ ^[0-9]+$ ]] || REPLY_ID="" | ||
| [[ "$REPLY_URL" =~ $URL_RE ]] || REPLY_URL="" | ||
| else | ||
| # Absence is normal for runs predating the info artifact; still surface the | ||
| # gh error so an auth/permission regression doesn't silently eat the rows. | ||
| echo "note: could not fetch unity_build_info_${target}_launcher: $(tr '\n' ' ' < "${dir}.err")" | ||
| fi | ||
| } | ||
|
|
||
| ROWS="" | ||
| for entry in "windows64:Windows" "macos:Mac"; do | ||
| target="${entry%%:*}" | ||
| label="${entry#*:}" | ||
| parse_info "$target" | ||
| # A URL without a valid id only occurs on a tampered artifact — drop the row | ||
| # rather than render an empty "[#](...)" label. | ||
| if [ -n "$REPLY_ID" ] && [ -n "$REPLY_URL" ]; then | ||
| ROWS+="| Unity Cloud build (${label}) | [#${REPLY_ID}](${REPLY_URL}) |"$'\n' | ||
| elif [ -n "$REPLY_ID" ]; then | ||
| ROWS+="| Unity Cloud build (${label}) | #${REPLY_ID} |"$'\n' | ||
| fi | ||
| done | ||
|
|
||
| SECTION="" | ||
| if [ -n "$ROWS" ]; then | ||
| SECTION="| Name | Link |"$'\n'"| -------- | ----------------------- |"$'\n'"$ROWS" | ||
| fi | ||
|
|
||
| # The payload derives from artifact bytes, so the heredoc delimiter must not be | ||
| # guessable content even though the validation above already forbids newlines. | ||
| DELIM="UCB_EOF_${RANDOM}${RANDOM}_$$" | ||
| { | ||
| echo "rows<<${DELIM}" | ||
| printf '%s' "$ROWS" | ||
| echo "${DELIM}" | ||
| echo "section<<${DELIM}" | ||
| printf '%s' "$SECTION" | ||
| echo "${DELIM}" | ||
| } >> "$GITHUB_OUTPUT" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,6 +61,13 @@ def _extract_member(self, member, targetpath, pwd): | |
|
|
||
| build_healthy = True | ||
|
|
||
| # Deep link to this build in the Unity Cloud dashboard, captured from the first build | ||
| # response that carries one. Persisted to BUILD_LINK_INFO_PATH so the workflow can | ||
| # upload it and the PR status comment can link the build directly. | ||
| BUILD_LINK_INFO_PATH = 'unity_cloud_build_info.env' | ||
| dashboard_url = None | ||
| _build_link_info_written = False | ||
|
|
||
| parser = argparse.ArgumentParser() | ||
| parser.add_argument('--resume', help='Resume tracking a running build stored in build_info.json', action='store_true') | ||
| parser.add_argument('--cancel', help='Cancel a running build stored in build_info.json', action='store_true') | ||
|
|
@@ -616,6 +623,45 @@ def try_resume_build(): | |
| return None | ||
|
|
||
|
|
||
| def record_build_link_info(id, response_json): | ||
| """Persist the Unity Cloud dashboard deep link for this build (best-effort). | ||
|
|
||
| Build API responses carry dashboard links; the workflow uploads the written file | ||
| as an artifact so the PR status comment can link the build id directly instead | ||
| of telling humans to search cloud.unity.com by hand. | ||
| """ | ||
| global dashboard_url, _build_link_info_written | ||
|
|
||
| links = response_json.get('links') or {} | ||
| href = None | ||
| # dashboard_summary is the build's page and dashboard_log its log tab; | ||
| # dashboard_url can be just the dashboard root, so a candidate only | ||
| # qualifies when it is an absolute link to this specific build (the | ||
| # comment workflow rejects anything else, so don't persist it either). | ||
| for key in ('dashboard_summary', 'dashboard_log', 'dashboard_url'): | ||
| candidate = (links.get(key) or {}).get('href') | ||
| if candidate and candidate.startswith('https://') and '/builds/' in candidate: | ||
| href = candidate | ||
| break | ||
|
|
||
| if _build_link_info_written and not href: | ||
| return | ||
|
|
||
| try: | ||
| with open(BUILD_LINK_INFO_PATH, 'w') as f: | ||
| f.write(f'BUILD_TARGET={os.getenv("TARGET")}\n') | ||
| f.write(f'BUILD_ID={id}\n') | ||
| if href: | ||
| f.write(f'DASHBOARD_URL={href}\n') | ||
| except OSError as e: | ||
| print(f'Warning: could not write {BUILD_LINK_INFO_PATH}: {e}') | ||
|
|
||
| if href: | ||
| dashboard_url = href | ||
| print(f'::notice::Unity Cloud build #{id} ({os.getenv("TARGET")}): {href}') | ||
| _build_link_info_written = True | ||
|
|
||
|
|
||
| def write_step_summary(target, build_id, final_status, phase_durations, queue_reasons, queue_elapsed, build_elapsed): | ||
| """Append a phase breakdown to $GITHUB_STEP_SUMMARY (best-effort).""" | ||
| summary_path = os.environ.get('GITHUB_STEP_SUMMARY') | ||
|
|
@@ -635,6 +681,8 @@ def fmt(seconds): | |
| lines.append('') | ||
| lines.append(f'- Target: `{target}`') | ||
| lines.append(f'- Build ID: `{build_id}`') | ||
| if dashboard_url: | ||
| lines.append(f'- Unity Cloud build page: {dashboard_url}') | ||
| lines.append(f'- Final outcome: `{final_status}`') | ||
| if queue_reasons: | ||
| lines.append(f"- Queue reasons seen: {', '.join(f'`{r}`' for r in sorted(queue_reasons))}") | ||
|
|
@@ -711,6 +759,9 @@ def run_poll_loop(id, build_already_active=False, resumed_build_elapsed=0): | |
|
|
||
| keep_polling, status, response_json = poll_build(id) | ||
|
|
||
| if dashboard_url is None: | ||
| record_build_link_info(id, response_json) | ||
|
|
||
| queued_reason = response_json.get('queuedReason') | ||
| if queued_reason and status in QUEUE_STATUSES: | ||
| queue_reasons.add(queued_reason) | ||
|
|
@@ -852,6 +903,10 @@ def get_clean_build_bool(): | |
| utils.persist_build_info(os.getenv('TARGET'), None) | ||
| id = run_build(os.getenv('BRANCH_NAME'), get_clean_build_bool()) | ||
| utils.persist_build_info(os.getenv('TARGET'), id) | ||
| # Write the link info file (target + id, no URL yet) immediately so it exists | ||
| # even if the runner dies before the first poll; the poll loop upgrades it | ||
| # with the dashboard URL once a response carries one. | ||
| record_build_link_info(id, {}) | ||
| print(f'For more info and live logs, go to https://cloud.unity.com/ and search for target "{os.getenv('TARGET')}" and build ID "{id}"') | ||
|
|
||
| final_outcome, phase_durations, queue_reasons, queue_elapsed, build_elapsed = run_poll_loop( | ||
|
|
@@ -920,7 +975,8 @@ def probe_latest_build(): | |
| download_log(id) | ||
|
|
||
| if not build_healthy: | ||
| where = dashboard_url or f'https://cloud.unity.com/ (search for target "{os.getenv("TARGET")}" and build ID "{id}")' | ||
| print(f'Build unhealthy - check the downloaded logs or the Unity Cloud build page: {where}') | ||
| sys.exit(1) | ||
|
|
||
| # Cleanup (only if build is healthy and not release) | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The producer now requires
'/builds/' in candidate(build.py:641) but the consumer still accepts any path under the three hosts, and the charset admits?,=,&and%. On the tampered-artifact path that leaves one narrow primitive: a fork can uploadDASHBOARD_URL=https://cloud.unity.com/<something>?next=https%3A%2F%2Fevil.example, which passes validation and renders as[#123](…)in the comment — a maintainer-facing link that reads as first-party. It only goes anywhere if Unity has an open redirect, so this is speculative, not a known bug.Cheap to close by mirroring the producer's own constraint, which also keeps the two validators in sync:
(Worth a quick check against a real dashboard URL first — if the id segment is followed by nothing, the trailing class still matches empty.)