Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update tokio-console screenshots for v0.1.13 #591

Merged
merged 4 commits into from
Oct 24, 2024

Commits on Oct 22, 2024

  1. chore: update tokio-console screenshots for v0.1.13

    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.
    hds committed Oct 22, 2024
    Configuration menu
    Copy the full SHA
    a747a6b View commit details
    Browse the repository at this point in the history
  2. remove redundant docs build

    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 committed Oct 22, 2024
    Configuration menu
    Copy the full SHA
    b303247 View commit details
    Browse the repository at this point in the history

Commits on Oct 23, 2024

  1. use xtask to check docs images

    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 committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    3011906 View commit details
    Browse the repository at this point in the history
  2. fix intentional regex error

    Now CI should pass..
    hds committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    3f58065 View commit details
    Browse the repository at this point in the history