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

[#40] Add Markdown Linting CI job #46

Closed

Conversation

0101coding
Copy link

@0101coding 0101coding commented Aug 19, 2022

Add markdown files lint CI job using this GitHub action:

Resolves:

@John15321 John15321 linked an issue Aug 22, 2022 that may be closed by this pull request
@John15321 John15321 added this to the 🚀 Finish the CI/CD setup milestone Aug 22, 2022
@John15321 John15321 added documentation Improvements or additions to documentation CI/CD labels Aug 22, 2022
@John15321 John15321 self-requested a review August 22, 2022 12:17
runs-on: ubuntu-latest
steps:
- name: Lint markdown files
uses: actionshub/markdownlint@main
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a warning to ignore. We know that in the Changelog there will be multiple same headers which will cause it to throw an error
markdownlint/markdownlint#175

@John15321 John15321 changed the title Added Markdown Linting [#40] Add Markdown Linting CI job Aug 22, 2022
@John15321 John15321 closed this Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Markdown Linting CI Job
2 participants