chore: Enable security lints and clean up documentation formatting#375
Conversation
Signed-off-by: UncleSp1d3r <unclesp1d3r@evilbitlabs.io>
Signed-off-by: UncleSp1d3r <unclesp1d3r@evilbitlabs.io>
WalkthroughThe PR removes Markdown formatter exclusions, regenerates changelog spacing, relocates the Cargo workspace lint opt-in, and reformats security-assurance tables without changing their content. ChangesFormatting and manifest updates
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 9 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (9 passed)
✨ Finishing Touches📝 Generate docstrings
Warning Review ran into problems🔥 ProblemsThese MCP integrations need to be re-authenticated in the Integrations settings: Linear, Notion Comment |
Merge Protections🔴 2 of 4 protections blocking · waiting on 🤖 CI
🔴 🚦 Auto-queueThis rule is failing.When all merge protections are satisfied and these conditions match, this pull request will be queued automatically.
🟠 Full CI must passWaiting for
Waiting checks:
|
There was a problem hiding this comment.
Pull request overview
This PR tightens project hygiene by ensuring Rust workspace lint configuration is actually applied to the root package, and by normalizing markdown formatting in project documentation and release notes.
Changes:
- Repositions the root package’s
[lints] workspace = trueopt-in so workspace lints are enforced. - Normalizes markdown formatting in
CHANGELOG.mdand fixes table rendering indocs/src/security-assurance.md. - Simplifies mdformat configuration by removing the explicit exclude list.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
Cargo.toml |
Moves the package lint opt-in ([lints] workspace = true) to ensure workspace lints apply; minor comment wording now needs to be updated. |
CHANGELOG.md |
Adds consistent blank lines and normalizes git-cliff generated markers between sections. |
docs/src/security-assurance.md |
Fixes markdown table formatting so the security principles/CWE tables render as tables (not code blocks). |
.mdformat.toml |
Removes the repo-wide exclude list, leaving core mdformat settings and extensions. |
| # Opt this package into the workspace lint table below. Without this, | ||
| # [workspace.lints] is inert and none of the security lints apply. | ||
| [lints] | ||
| workspace = true |
This pull request primarily makes two changes: it fixes the enforcement of workspace lints by moving the
[lints] workspace = truesection inCargo.tomlto the correct location, and it cleans up the formatting ofCHANGELOG.mdby ensuring a consistent separation between sections. Additionally, it removes the file exclusion list from.mdformat.toml.The most important changes are:
Lint enforcement:
[lints] workspace = trueto the correct position inCargo.tomlto ensure workspace-wide linting is actually enforced. Previously, this section was misplaced and thus inert. [1] [2]Changelog formatting:
CHANGELOG.md, improving readability and ensuring automated changelog tools work as intended. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]Formatting configuration:
.mdformat.toml, likely to simplify or update markdown formatting rules.