Skip to content

Commit eff20bd

Browse files
authored
chore: update tokio-console screenshots for v0.1.13 (#591)
The screenshots on the docs.rs page for tokio-console are a bit out of date. They are from v0.1.8 and still show the Target column instead of the Kind column. With the task size instrumentation and new lints which will be released in the next version of Tokio Console, we need screenshots which match what the user will see. The same goes for the screenshots in the repository root README.md, which anyone visiting the repo page on GitHub will see. This change adds new screenshots for docs.rs and replaces the README screenshots. We have to keep the docs.rs images from previous versions still, since docs.rs pages for previous versions still reference them. Additionally, a new CI job to build the docs.rs documentation and also to check that all the images referenced from the tokio-console README file (which is used on docs.rs) are present in the repository, as we can't inspect the documentation until the change is merged. This is done via a new `xtask` operation.
1 parent f4ee0df commit eff20bd

File tree

11 files changed

+104
-7
lines changed

11 files changed

+104
-7
lines changed

.github/workflows/ci.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,23 @@ jobs:
101101
- name: Run cargo clippy
102102
run: cargo clippy --workspace --all-targets --no-deps -- -D warnings
103103

104+
docs:
105+
name: Docs
106+
runs-on: ubuntu-latest
107+
steps:
108+
- name: Checkout sources
109+
uses: actions/checkout@v4
110+
111+
- name: Install ${{ matrix.rust }} toolchain
112+
uses: dtolnay/rust-toolchain@master
113+
with:
114+
toolchain: stable
115+
116+
- uses: Swatinem/rust-cache@v2
117+
118+
- name: Run xtask check-docs-images
119+
run: cargo run --bin xtask -- check-docs-images
120+
104121
grpc_web:
105122
name: gRPC-web Example
106123
runs-on: ubuntu-latest

assets/readme/task-details.png

-26.8 KB
Loading

assets/readme/top-for-tasks.png

106 KB
Loading
347 KB
Loading
147 KB
Loading
511 KB
Loading
236 KB
Loading
375 KB
Loading

tokio-console/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ tokio-console --lang en_US.UTF-8
121121
When the console CLI is launched, it displays a list of all [asynchronous tasks]
122122
in the program:
123123

124-
![tasks list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/tasks_list.png)
124+
![tasks list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/tasks_list.png)
125125

126126
Tasks are displayed in a table.
127127

@@ -154,7 +154,7 @@ task.
154154

155155
This view shows details about a specific task:
156156

157-
![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/task_details.png)
157+
![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/task_details.png)
158158

159159
The task details view includes percentiles and a visual histogram of the polling (busy) times
160160
and scheduled times.
@@ -166,7 +166,7 @@ Pressing the <kbd>escape</kbd> key returns to the task list.
166166
The <kbd>r</kbd> key switches from the list of tasks to a list of [resources],
167167
such as synchronization primitives, I/O resources, et cetera:
168168

169-
![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resources_list.png)
169+
![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/resources_list.png)
170170

171171
Resources are displayed in a table similar to the task list.
172172

@@ -192,13 +192,13 @@ while a resource is highlighted displays details about that resource.
192192

193193
### Resource Details
194194

195-
![resource details --- sleep](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resource_details_sleep.png)
195+
![resource details --- sleep](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/resource_details_sleep.png)
196196

197197
The resource details view lists the tasks currently waiting on that resource.
198198
This may be a single task, as in the [`tokio::time::Sleep`] above, or
199199
a large number of tasks, such as this private `tokio::sync::batch_semaphore::Semaphore`:
200200

201-
![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resource_details_semaphore.png)
201+
![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.13/resource_details_semaphore.png)
202202

203203
The resource details view includes a table of async ops belonging to the resource.
204204

xtask/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ tonic-build = { version = "0.12", default-features = false, features = [
1212
] }
1313
clap = { version = "~4.5.4", features = ["derive"] }
1414
color-eyre = "0.6"
15+
regex = "1.11.0"

0 commit comments

Comments
 (0)