chore: check .md files with markdownlint-cli #1803
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1803 +/- ##
=======================================
Coverage 87.04% 87.04%
=======================================
Files 68 68
Lines 2579 2579
Branches 561 561
=======================================
Hits 2245 2245
Misses 298 298
Partials 36 36 🚀 New features to boost your workflow:
|
samayer12
force-pushed
the
hotfix-md-lint
branch
from
0af8a3b to
83b51e1
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
cmwylie19
reviewed
Feb 10, 2025
samayer12
force-pushed
the
hotfix-md-lint
branch
from
32eb7a8 to
f9ab5ff
Compare
samayer12
force-pushed
the
hotfix-md-lint
branch
2 times, most recently
from
ba87e2d to
eb6e7c0
Compare
samayer12
force-pushed
the
hotfix-md-lint
branch
from
eb6e7c0 to
04f4f36
Compare
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 7, 2025
## Description DOM was introduced to our tsconfig as some point which was a mistake. Our docs indicate that the _only_ reason to use DOM would be to bring in the web assembly types into a Pepr module. This PR removes DOM and updates some error messages that were not correct because they were looking for variables in the DOM types. This should unblock #1803 ## Related Issue Fixes # <!-- or --> Relates to # ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Unit, [Journey](https://github.com/defenseunicorns/pepr/tree/main/journey), [E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples), [docs](https://github.com/defenseunicorns/pepr/tree/main/docs), [adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or updated as needed - [x] [Contributor Guide Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request) followed Signed-off-by: Case Wylie <[email protected]>
|
Use of As a workaround, we could remove |
|
Since this is only a dev-tool that we do not need to distribute, we could use |
cmwylie19
approved these changes
May 29, 2025
github-project-automation
bot
moved this from 🆕 New
to 👀 In review
in Pepr Project Board
github-project-automation
bot
moved this from 👀 In review
to ✅ Done
in Pepr Project Board
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.
Description
While working on #1776, I noticed that we do not use a markdown linter. We should lint our markdown code since it's used to create user-facing documentation. This PR adds
markdownlint-clias a project dependency and configures.mdlinting upon commit.Related Issue
Fixes #2120
Relates to #1776
Type of change
Checklist before merging