chore: update tokio-console screenshots for v0.1.13 #591
Conversation
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
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.
seanmonstar
approved these changes
Oct 22, 2024
We're already building the docs on netlify, so no need to do it in GitHub CI as well. We'll just keep the check for assets.
hds
force-pushed
the
hds/update-screenshots-tokio-console-0-1-13
branch
from
0850bf2 to
1563e91
Compare
Rather than using a bash script, let's do things properly and validate the presence of the images in the Tokio Console README.md file with an xtask operation. This commit intentially has an error in the regex to check that the CI step is working.
hds
force-pushed
the
hds/update-screenshots-tokio-console-0-1-13
branch
from
1563e91 to
3011906
Compare
Now CI should pass..
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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
xtaskoperation.