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

[editorial] markdownlint in less then 1.5 sec #193

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Jul 13, 2023

  • Adds a Gulp task named lint-md to run markdownlint
    • The task runs in less than 1.5 seconds over the same files as the markdownlint make target, which takes much longer, when run from the command line
  • Fixes the errors reported by markdownlint Gulp task. I'm unsure why, with the same config, the CLI misses those errors
  • Replaces the call to the markdownlint CLI with the Gulp task in the markdownlint job

@chalin chalin requested review from a team July 13, 2023 21:17
@chalin
Copy link
Contributor Author

chalin commented Jul 13, 2023

As you can see from the GH actions above, the new Gulp task takes 17s to do markdownlint checks (that includes running npm install).

Copy link
Member

@joaopgrassi joaopgrassi left a comment

Choose a reason for hiding this comment

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

I don't have experience in gulp but I'm all in for making the check faster, that's great! Just one thing, could we also make it use the same in the make task markdown-link-check?

@chalin
Copy link
Contributor Author

chalin commented Jul 14, 2023

... also make it use the same in the make task markdown-link-check?

@joaopgrassi - done

Copy link
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

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

Thanks for this! Markdownlint's time was pretty insane before.

@jsuereth jsuereth merged commit ed0bcea into open-telemetry:main Jul 14, 2023
@chalin chalin deleted the chalin-im-markdownlint-fixes-2023-07-13 branch July 14, 2023 12:11
rapphil pushed a commit to rapphil/semantic-conventions that referenced this pull request Aug 14, 2023
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