Skip to content

Commit 307a3db

Browse files
committed
docs: README and CHANGELOG follow the timing trim
1 parent 3d7d78a commit 307a3db

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com); releases are
99

1010
- `sccache`: installs a pinned sccache (version + per-arch sha256) as `RUSTC_WRAPPER`; the backend is whatever `SCCACHE_*` the job environment carries, and `"auto"` no-ops without one, so one workflow runs unchanged on hosted and self-hosted runners.
1111
`mode: gha` targets GitHub's cache service instead; an explicit opt-in, since it exports the masked Actions runtime token into the job env and spends the repository's cache pool.
12-
- `sccache-stats`: hit/miss/request facts as `cache.sccache.*` rows in timing-report's Cache section, run as a late job step; never fails a job.
12+
- `sccache-stats`: hit/miss/request facts as `cache.sccache.*` rows in the step summary and in timing-report's Cache section, run as a late job step; never fails a job.
1313
- `crates-mirror`: writes the crates-io source replacement into `$CARGO_HOME/config.toml` from the `url` input or `RUST_CI_CRATES_MIRROR` in the job environment (source replacement is config-file-only, cargo#5416).
1414
Lockfile checksums keep pinning canonical crates.io hashes, so the mirror is an availability dependency, not a trust dependency.
1515
- `cut-release`: stamps a `CITATION.cff` into the release commit, where the repository keeps one: top-level `version`, and `date-released` where the file has one, both on the cut's date.
@@ -37,12 +37,17 @@ The format follows [Keep a Changelog](https://keepachangelog.com); releases are
3737
- `publish-dry-run`: the prep refuses a `.crate` whose file list contains a cargo build tree or a cargo home, instead of validating an archive that packages them.
3838
- `changelog`: candidate marker tags (`vX.Y.Z-rcN`) no longer set the baseline for a stable version; a release-candidate version still measures against earlier candidates.
3939
- `cargo-publish` and every snippet: `rust-lang/crates-io-auth-action` sets a `token` output, which is passed as `registry-token`; it never exported `CARGO_REGISTRY_TOKEN`.
40+
- `timing-report`: stages are the job's steps as the Actions API reports them (`actions: read`); without the API the report shows the job totals as one stage named after the job, warns, and still exits 0.
41+
The `total-ms` output is declared.
42+
- `rust-cache`, `rust-cache-save`: the cache facts also render as a table in the step's own summary, so they show without `timing-report`.
4043
- **Breaking:** the release flow has one go-live: a human-signed annotated tag; `require-signed-tag` gates the tag pipeline and `cargo-publish` runs behind it.
4144
The candidate loop (`draft-release`, `release-guidance`) stays as the optional preview; `publish-draft-release` keeps the seal, the draft flip and the moving major.
4245
- The reference pipeline `release.yml` gates its tag run on the signature: `check-release-readiness`, then `require-signed-tag`, then the seal-only step, and the tag trigger is plain `v*` again.
4346

4447
### Removed
4548

49+
- **Breaking:** `timing-mark`, the `first-stage` input of `timing-start` and the `RUST_CI_TIMING_DIR` export.
50+
Stages come from the Actions API; a consumer deletes its `timing-mark` steps and grants the job `actions: read`, and every reader resolves `$RUNNER_TEMP/rust-ci-timing` on its own.
4651
- `promote-release`: the pipeline no longer creates the final tag; a human signs and pushes it.
4752
- `require-signed-release` and the `vX.Y.Z-sig` companion convention: the signature lives on the release tag, checked by `require-signed-tag`, and no companion tag unlocks a registry upload.
4853
- `release-guidance`: the `go-live` input and the publish-draft rendering, and the `token` input that fed the ruleset probe.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Each name links to the action's README.
7979
| [`rust-cache`](.github/actions/rust-cache/README.md) | Restore cargo's registry cache and, optionally, `target/`. |
8080
| [`rust-cache-save`](.github/actions/rust-cache-save/README.md) | Prune `target/` to dependency artifacts and save it, as the job's last step. |
8181
| [`sccache`](.github/actions/sccache/README.md) | Install a pinned sccache as `RUSTC_WRAPPER`; the backend comes from `SCCACHE_*` in the job environment. |
82-
| [`sccache-stats`](.github/actions/sccache-stats/README.md) | Record sccache's hits and misses for the timing report. |
82+
| [`sccache-stats`](.github/actions/sccache-stats/README.md) | Record sccache's hits and misses in the step summary and for the timing report. |
8383
| [`crates-mirror`](.github/actions/crates-mirror/README.md) | Point cargo's crates-io source at a mirror URL. |
8484

8585
### Release
@@ -104,7 +104,7 @@ Each name links to the action's README.
104104

105105
| Action | Does |
106106
| --- | --- |
107-
| [`timing-start`](.github/actions/timing-start/README.md), [`timing-mark`](.github/actions/timing-mark/README.md), [`timing-report`](.github/actions/timing-report/README.md) | Per-stage durations, CPU and memory for one job, rendered into the step summary. |
107+
| [`timing-start`](.github/actions/timing-start/README.md), [`timing-report`](.github/actions/timing-report/README.md) | Per-step durations from the Actions API, CPU and memory from a sampler, for one job, rendered into the step summary. |
108108

109109
## Self-hosted runners
110110

0 commit comments

Comments
 (0)