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.

Sign up for GitHub

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

Jump to bottom

458: Markdown linter as a local npm script & Git Action execution #503

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

458: Markdown linter as a local npm script & Git Action execution #503

wants to merge 14 commits into from

Conversation

adigidh
Copy link

@adigidh adigidh commented Sep 24, 2024

fixes #458

Summary of Changes:

  • Custom Markdown Linting configuration : .markdownlint.yml that holds the rules (can be updated based on our requirements)
  • NPM script added to the project to complete markdown linting locally: markdownlint-cli2 is the CLI tool that helps us with the script execution.
  • npm run lint will produce results for the markdown linting errors.
  • npm run lint: fix will help to auto fix these issues for markdown linting
  • Updated Markdown files with corresponding linting fixes
  • Markdown Linter named Github Action added to the workflows which does the following:
    - Uses a custom configuration file
    - Runs markdown linter on markdown files in the docs directory
    - continue-on-error: true parameter set currently to not fail the github action on every pull request

Aditya Gidh added 9 commits September 24, 2024 11:16
adding package for local run for md linting
4e18b76 
Signed-off-by: Aditya Gidh <[email protected]>
markdown linting basic configuration
f2f89a8 
Signed-off-by: Aditya Gidh <[email protected]>
git action for markdown linting
1db418b 
Signed-off-by: Aditya Gidh <[email protected]>
switching to an explicit config
3ed4bbd 
Signed-off-by: Aditya Gidh <[email protected]>
linting updates to markdown files
83ae9fc 
Signed-off-by: Aditya Gidh <[email protected]>
fix directory path for linting git action
cf50dfd 
Signed-off-by: Aditya Gidh <[email protected]>
attempt to fix relative paths for working directory
f32f091 
Signed-off-by: Aditya Gidh <[email protected]>
update git actions for linting markdowns
c3f6ec1 
Signed-off-by: Aditya Gidh <[email protected]>
support custom config options for workflow
9b37f22 
Signed-off-by: Aditya Gidh <[email protected]>
@maia-iyer maia-iyer changed the base branch from dev to main September 25, 2024 15:09
mamy-CS
mamy-CS reviewed Sep 30, 2024
View reviewed changes
Copy link
Collaborator

@mamy-CS mamy-CS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this, let's fix some of the lint errors on the pr docs/blogs.md and this should be good to go.

@adigidh
Copy link
Author

adigidh commented Sep 30, 2024

Thank you for this, let's fix some of the lint errors on the pr docs/blogs.md and this should be good to go.

Thanks for taking a look @mamy-CS.
Made the corresponding updates. Changed some yaml rules to avoid noise in the resulting markdown files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mamy-CS mamy-CS mamy-CS left review comments

@lumjjb lumjjb Awaiting requested review from lumjjb lumjjb is a code owner

@mrsabath mrsabath Awaiting requested review from mrsabath mrsabath is a code owner

@maia-iyer maia-iyer Awaiting requested review from maia-iyer maia-iyer is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a markdown linter
2 participants
@adigidh @mamy-CS