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

chore(lint): refactor Markdown linting to use markdownlint-cli2 #2234

Merged
merged 10 commits into from
May 30, 2024

Commits on May 22, 2024

  1. chore(lint): refactor Markdown linting to use markdownlint-cli2

    This switches from `markdownlint-cli` to `markdownlint-cli2` and drops
    usage of the https://github.com/avto-dev/markdown-lint GitHub action in CI.
    
    - The `avto-dev/markdown-lint` action was using a 4y old version of `markdownlint`.
      AFAICT that action is not being maintained.
    - There is a new `npm run lint:markdown` and the `lint.yml` CI workflow uses it.
    - The switch from `markdownlint-cli` to `markdownlint-cli2` and `.markdownlint-cli2.jsonc`
      as the config allows using the https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
      VSCode plugin for in-editor Markdown lint warnings and intellisense in the config file.
    
    Refs: open-telemetry/opentelemetry-js#4713
    trentm committed May 22, 2024
    Configuration menu
    Copy the full SHA
    f4c99dc View commit details
    Browse the repository at this point in the history

Commits on May 23, 2024

  1. Configuration menu
    Copy the full SHA
    4733ea4 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    c5233da View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1d35785 View commit details
    Browse the repository at this point in the history
  4. re-enable the MD026/no-trailing-punctuation rule default (the core re…

    …po disables this rule)
    trentm committed May 23, 2024
    Configuration menu
    Copy the full SHA
    fef57e2 View commit details
    Browse the repository at this point in the history
  5. re-enable MD045/no-alt-text

    trentm committed May 23, 2024
    Configuration menu
    Copy the full SHA
    42b1959 View commit details
    Browse the repository at this point in the history
  6. some rules to discuss

    trentm committed May 23, 2024
    Configuration menu
    Copy the full SHA
    53a3adc View commit details
    Browse the repository at this point in the history
  7. opt to avoid "<!-- markdownlist-disable ... -->" directives in every …

    …CHANGELOG.md file and choose options that work for all .md files
    trentm committed May 23, 2024
    Configuration menu
    Copy the full SHA
    2e03f59 View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    8dba7f6 View commit details
    Browse the repository at this point in the history

Commits on May 30, 2024

  1. Configuration menu
    Copy the full SHA
    4f99405 View commit details
    Browse the repository at this point in the history