Skip to content

Add documentation URL to selected jobs#136911

Merged
bors merged 4 commits intorust-lang:masterfrom
Kobzol:ci-helper-link
Mar 14, 2025
Merged

Add documentation URL to selected jobs#136911
bors merged 4 commits intorust-lang:masterfrom
Kobzol:ci-helper-link

Conversation

@Kobzol
Copy link
Member

@Kobzol Kobzol commented Feb 12, 2025 •
edited
Loading

This PR adds the possibility to attach URLs to selected CI jobs, which are then printed at the end of the CI log when a failure happens in that job. The motivation is to allow contributors to find how to fix the specific jobs more quickly.

This was proposed on Zulip.

An example output can be seen here.

r? @ghost

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 12, 2025
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rustbot rustbot added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Feb 12, 2025
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rustbot rustbot added A-testsuite Area: The testsuite used to check the correctness of rustc T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. labels Mar 5, 2025
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@bors
Copy link
Collaborator

bors commented Mar 11, 2025

☔ The latest upstream changes (presumably #138350) made this pull request unmergeable. Please resolve the merge conflicts.

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@Kobzol Kobzol changed the title [WIP] Test displaying CI helper links Add documentation URL to selected jobs Mar 13, 2025
@Kobzol Kobzol marked this pull request as ready for review March 13, 2025 13:58
@Kobzol
Copy link
Member Author

Kobzol commented Mar 13, 2025

r? @marcoieni

Kobzol
Kobzol commented Mar 13, 2025
View reviewed changes
src/ci/run.sh
echo "[CI_JOB_NAME=$CI_JOB_NAME]"
fi

if [ -n "$CI_JOB_DOC_URL" ]; then
Copy link
Member Author

@Kobzol Kobzol Mar 13, 2025

Choose a reason for hiding this comment

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

I added this because I want to also add the URL to the comments posted by Rust Log Analyzer. This log entry should help RLA figure out what is the documentation URL.

marcoieni
marcoieni approved these changes Mar 13, 2025
View reviewed changes
Copy link
Member

@marcoieni marcoieni left a comment

Choose a reason for hiding this comment

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

looks good. feel free to r=me 👍

@Kobzol
Copy link
Member Author

Kobzol commented Mar 13, 2025

@bors r=marcoieni

@bors
Copy link
Collaborator

bors commented Mar 13, 2025

📌 Commit 0c6d24e has been approved by marcoieni

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 13, 2025
@Kobzol Kobzol mentioned this pull request Mar 13, 2025
Merged
@jhpratt jhpratt mentioned this pull request Mar 14, 2025
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 14, 2025
@bors
Auto merge of rust-lang#138480 - jhpratt:rollup-y3b8wu5, r=jhpratt
f7b4354 
Rollup of 16 pull requests

Successful merges:

 - rust-lang#136001 (Overhaul examples for PermissionsExt)
 - rust-lang#136230 (Reword incorrect documentation about SocketAddr having varying layout)
 - rust-lang#136892 (Sync Fuchsia target spec with clang Fuchsia driver)
 - rust-lang#136911 (Add documentation URL to selected jobs)
 - rust-lang#137870 ( Improve HashMap docs for const and static initializers)
 - rust-lang#138179 (Add `src/tools/x` to the main workspace)
 - rust-lang#138389 (use `expect` instead of `allow`)
 - rust-lang#138396 (Enable metrics and verbose tests in PR CI)
 - rust-lang#138398 (atomic intrinsics: clarify which types are supported and (if applicable) what happens with provenance)
 - rust-lang#138432 (fix: remove the check of lld not supporting `@response-file)`
 - rust-lang#138434 (Visit `PatField` when collecting lint levels)
 - rust-lang#138441 (update error message)
 - rust-lang#138442 (EUV: fix place of deref pattern's interior's scrutinee)
 - rust-lang#138457 (Remove usage of legacy scheme paths on RedoxOS)
 - rust-lang#138461 (Remove an outdated line from a test comment)
 - rust-lang#138466 (Remove myself from libs review)

Failed merges:

 - rust-lang#138452 (Remove `RUN_CHECK_WITH_PARALLEL_QUERIES`)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 6ae5c8d into rust-lang:master Mar 14, 2025
6 checks passed
@rustbot rustbot added this to the 1.87.0 milestone Mar 14, 2025
@Kobzol Kobzol deleted the ci-helper-link branch March 14, 2025 10:08
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Mar 14, 2025
@rust-timer
Unrolled build for rust-lang#136911
f0d7edb 
Rollup merge of rust-lang#136911 - Kobzol:ci-helper-link, r=marcoieni

Add documentation URL to selected jobs

This PR adds the possibility to attach URLs to selected CI jobs, which are then printed at the end of the CI log when a failure happens in that job. The motivation is to allow contributors to find how to fix the specific jobs more quickly.

This was proposed on [Zulip](https://rust-lang.zulipchat.com/#narrow/channel/242791-t-infra/topic/Automatic.20useful.20links.20when.20a.20particular.20CI.20job.20fails.3F).

An example output can be seen [here](https://github.com/rust-lang/rust/actions/runs/13836290091/job/38712112523?pr=136911).

r? `@ghost`
@Kobzol Kobzol mentioned this pull request Mar 14, 2025
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 14, 2025
@bors
Auto merge of rust-lang#138487 - Kobzol:fix-doc-url-docker, r=<try>
d8fdaa8 
Pass `CI_JOB_DOC_URL` to Docker

Fix-up for rust-lang#136911. I always forget to pass new environment variables to Docker images.. 🤦‍♂️

r? `@marcoieni`

try-job: x86_64-fuchsia
fmease added a commit to fmease/rust that referenced this pull request Mar 14, 2025
@fmease
Rollup merge of rust-lang#138487 - Kobzol:fix-doc-url-docker, r=marco…
c5e3857 
…ieni

Pass `CI_JOB_DOC_URL` to Docker

Fix-up for rust-lang#136911. I always forget to pass new environment variables to Docker images.. 🤦‍♂️

r? `@marcoieni`

try-job: x86_64-fuchsia
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Mar 14, 2025
@rust-timer
Unrolled build for rust-lang#138487
2e45b52 
Rollup merge of rust-lang#138487 - Kobzol:fix-doc-url-docker, r=marcoieni

Pass `CI_JOB_DOC_URL` to Docker

Fix-up for rust-lang#136911. I always forget to pass new environment variables to Docker images.. 🤦‍♂️

r? `@marcoieni`

try-job: x86_64-fuchsia
github-actions bot pushed a commit to rust-lang/rustc-dev-guide that referenced this pull request Mar 17, 2025
@fmease
Rollup merge of #138487 - Kobzol:fix-doc-url-docker, r=marcoieni
13b6424 
Pass `CI_JOB_DOC_URL` to Docker

Fix-up for rust-lang/rust#136911. I always forget to pass new environment variables to Docker images.. 🤦‍♂️

r? `@marcoieni`

try-job: x86_64-fuchsia
github-actions bot pushed a commit to model-checking/verify-rust-std that referenced this pull request Mar 19, 2025
@bors
Auto merge of rust-lang#138480 - jhpratt:rollup-y3b8wu5, r=jhpratt
0b766fc 
Rollup of 16 pull requests

Successful merges:

 - rust-lang#136001 (Overhaul examples for PermissionsExt)
 - rust-lang#136230 (Reword incorrect documentation about SocketAddr having varying layout)
 - rust-lang#136892 (Sync Fuchsia target spec with clang Fuchsia driver)
 - rust-lang#136911 (Add documentation URL to selected jobs)
 - rust-lang#137870 ( Improve HashMap docs for const and static initializers)
 - rust-lang#138179 (Add `src/tools/x` to the main workspace)
 - rust-lang#138389 (use `expect` instead of `allow`)
 - rust-lang#138396 (Enable metrics and verbose tests in PR CI)
 - rust-lang#138398 (atomic intrinsics: clarify which types are supported and (if applicable) what happens with provenance)
 - rust-lang#138432 (fix: remove the check of lld not supporting `@response-file)`
 - rust-lang#138434 (Visit `PatField` when collecting lint levels)
 - rust-lang#138441 (update error message)
 - rust-lang#138442 (EUV: fix place of deref pattern's interior's scrutinee)
 - rust-lang#138457 (Remove usage of legacy scheme paths on RedoxOS)
 - rust-lang#138461 (Remove an outdated line from a test comment)
 - rust-lang#138466 (Remove myself from libs review)

Failed merges:

 - rust-lang#138452 (Remove `RUN_CHECK_WITH_PARALLEL_QUERIES`)

r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@marcoieni marcoieni marcoieni approved these changes

Assignees

@marcoieni marcoieni

Labels

A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.87.0

Development

Successfully merging this pull request may close these issues.

5 participants

@Kobzol @rust-log-analyzer @bors @marcoieni @rustbot