Skip to content

Commit

Permalink
attempt to fix github action, make markdown lint happy
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperFluffy committed Dec 28, 2023
1 parent f91abdf commit 5b3f738
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,8 @@ jobs:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain
with:
# This has to match `rust-toolchain` in the rust-toolchain file of the dylint lints
toolchain: nightly-2023-10-06
components: "clippy llvm-tools-preview, rustc-dev"
components: "clippy, llvm-tools-preview, rustc-dev"
- uses: Swatinem/rust-cache@v2.6.1
with:
cache-provider: "buildjet"
Expand All @@ -181,7 +180,6 @@ jobs:
- name: run clippy against custom lints
run: |
cargo clippy --all-targets --all-features \
# Explicitly list all lints here
-p tracing_debug_field \
-- --warn clippy::pedantic --deny warnings
- name: run dylint clippy on workspace crates
Expand Down
8 changes: 4 additions & 4 deletions lint/tracing_debug_field/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# `tracing_debug_field`

### What it does
## What it does

Warns about fields in `tracing::event!` macros that are debug formatted
using either the `?` sigil or the [`tracing::field::debug`](https://docs.rs/tracing/0.1.40/tracing/field/fn.debug.html)

Check failure on line 6 in lint/tracing_debug_field/README.md

View workflow job for this annotation

GitHub Actions / markdown

Trailing spaces

lint/tracing_debug_field/README.md:6:120 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md009.md

Check failure on line 6 in lint/tracing_debug_field/README.md

View workflow job for this annotation

GitHub Actions / markdown

Line length

lint/tracing_debug_field/README.md:6:81 MD013/line-length Line length [Expected: 80; Actual: 120] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md013.md
utility.

### Why is this bad?
## Why is this bad?

Debug formatted fields are bad for observability as they are usually unparseable and

Check failure on line 11 in lint/tracing_debug_field/README.md

View workflow job for this annotation

GitHub Actions / markdown

Line length

lint/tracing_debug_field/README.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 84] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md013.md
unreadable. They also surface language-specific implementation details that are unnecessary
and too verbose for operators.

### What to do instead
## What to do instead

Depending on the complexity of what must be logged:

Expand All @@ -26,7 +26,7 @@ Depending on the complexity of what must be logged:
5. Hash an object and emit the hash (this works very well for messages that will be otherwise recorded and

Check failure on line 26 in lint/tracing_debug_field/README.md

View workflow job for this annotation

GitHub Actions / markdown

Line length

lint/tracing_debug_field/README.md:26:81 MD013/line-length Line length [Expected: 80; Actual: 106] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md013.md
can be retrieved outside the observability intake).

### Example
## Example

Check failure on line 29 in lint/tracing_debug_field/README.md

View workflow job for this annotation

GitHub Actions / markdown

Headings should be surrounded by blank lines

lint/tracing_debug_field/README.md:29 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Example"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md022.md
```rust

Check failure on line 30 in lint/tracing_debug_field/README.md

View workflow job for this annotation

GitHub Actions / markdown

Fenced code blocks should be surrounded by blank lines

lint/tracing_debug_field/README.md:30 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```rust"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md031.md
#[derive(Clone, Copy, Debug)]
struct Wrapped(&'static str);
Expand Down

0 comments on commit 5b3f738

Please sign in to comment.