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

ci: lint markdown files #1147

Merged
merged 4 commits into from
Jun 8, 2020

Conversation

naseemkullah
Copy link
Member

@naseemkullah naseemkullah commented Jun 7, 2020

Which problem is this PR solving?

Short description of the changes

  • Adding markdown lint github action
  • Various rules are ignored via .markdownlint.json to facilitate integrating this into the CI (we can choose to remove any number of these rules from being ignored in subsequent PRs)

Special Notes

  • Please ignore whitespace changes for a better review experience.

  • It would be nice to get this in sooner than later since rebasing from other commits that include doc changes will be burdensome. 😬

@naseemkullah naseemkullah force-pushed the lint-markdown branch 2 times, most recently from 70e43c8 to 21cec07 Compare June 7, 2020 03:38
@codecov
Copy link

codecov bot commented Jun 7, 2020

Codecov Report

Merging #1147 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1147      +/-   ##
==========================================
- Coverage   92.32%   92.29%   -0.03%     
==========================================
  Files         116      116              
  Lines        3402     3402              
  Branches      689      689              
==========================================
- Hits         3141     3140       -1     
- Misses        261      262       +1     
Impacted Files Coverage Δ
packages/opentelemetry-tracing/src/Span.ts 98.73% <0.00%> (-1.27%) ⬇️

@naseemkullah naseemkullah force-pushed the lint-markdown branch 5 times, most recently from aa33b57 to bae4e2c Compare June 7, 2020 15:43
@naseemkullah naseemkullah marked this pull request as ready for review June 7, 2020 15:51
@naseemkullah naseemkullah changed the title ci: lint changelog ci: lint markdown files Jun 7, 2020
Copy link
Member

@dyladan dyladan left a comment

Choose a reason for hiding this comment

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

Good change thanks!

@naseemkullah naseemkullah merged commit e93a866 into open-telemetry:master Jun 8, 2020
@naseemkullah naseemkullah deleted the lint-markdown branch June 8, 2020 19:32
@open-telemetry open-telemetry deleted a comment from naseemkullah Jun 8, 2020
dyladan pushed a commit to dyladan/opentelemetry-js that referenced this pull request Sep 9, 2022
* ci: add markdown linting

Signed-off-by: Naseem <[email protected]>

* fix: lint markdown files

Signed-off-by: Naseem <[email protected]>

* docs: add markdown lint configuration

Signed-off-by: Naseem <[email protected]>

* docs: lint change log

Signed-off-by: Naseem <[email protected]>
dyladan added a commit to dyladan/opentelemetry-js that referenced this pull request Sep 9, 2022
* ci: add markdown linting

Signed-off-by: Naseem <[email protected]>

* fix: lint markdown files

Signed-off-by: Naseem <[email protected]>

* docs: add markdown lint configuration

Signed-off-by: Naseem <[email protected]>

* docs: lint change log

Signed-off-by: Naseem <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants