mirror of https://github.com/DavidAnson/markdownlint-cli2-action.git synced 2024-12-22 04:43:32 +01:00

A GitHub Action to run the markdownlint-cli2 tool for linting Markdown/CommonMark files with the markdownlint library

Find a file

dependabot[bot] 80839acc30 Bump eslint from 8.36.0 to 8.37.0 Bumps [eslint](https://github.com/eslint/eslint) from 8.36.0 to 8.37.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v8.36.0...v8.37.0) --- updated-dependencies: - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>		2023-03-29 09:55:34 -07:00
.github	Update documentation and examples to reference @v9.	2023-01-02 16:07:54 -08:00
config	Move .markdownlint.jsonc file to avoid interfering with action tests.	2022-07-22 23:16:36 -07:00
dist	Update index.js via "npm test".	2023-01-02 16:04:35 -08:00
test	Add passing/failing file and no/one glob to tests.	2021-01-13 14:29:36 -08:00
.eslintrc.json	Customize new ESLint rule unicorn/switch-case-braces.	2022-10-04 23:00:40 -07:00
.gitignore	Minor cleanup of unused/irrelevant components.	2021-01-13 14:17:17 -08:00
.npmrc	Default npm's ignore-scripts flag to true to prevent running pre- or post-scripts in package dependencies.	2022-12-23 15:33:43 -08:00
action.yml	Add "separator" input to enable using something other than "\n" for the globs input (fixes #58 ).	2022-11-30 03:29:42 +00:00
LICENSE	Update copyright year for 2022.	2022-01-22 15:36:45 -08:00
markdownlint-cli2-action.js	Add "separator" input to enable using something other than "\n" for the globs input (fixes #58 ).	2022-11-30 03:29:42 +00:00
package.json	Bump eslint from 8.36.0 to 8.37.0	2023-03-29 09:55:34 -07:00
README.md	Update documentation and examples to reference @v9.	2023-01-02 16:07:54 -08:00

README.md

markdownlint-cli2-action

A GitHub Action to run the markdownlint-cli2 tool for linting Markdown/CommonMark files with markdownlint

markdownlint-cli2 has extensive support for configuring options and disabling or customizing markdownlint rules. See the markdownlint-cli2 README for more information. markdownlint includes a wide variety of rules for analyzing and improving Markdown content. See the markdownlint README for more information.

Inputs

command (optional)

Command to run (unset, fix, or config)

If unspecified or "", the markdownlint-cli2 command is run.

If set to fix, the markdownlint-cli2-fix command is run and supported issues will be fixed automatically.

If set to config, the markdownlint-cli2-config command is run and the first element of globs should specify a supported configuration file.

For more detail: documentation for markdownlint-cli2.

globs (optional)

Glob expression(s) of files to lint (newline-delimited by default)

The default *.{md,markdown} lints all Markdown files in the base directory of a project.

For more detail: glob syntax in markdownlint-cli2.

separator (optional)

String to use as a separator for the globs input (defaults to newline)

Allows the globs input to use something other than \n to separate glob expressions.

Outputs

[None]

Examples

To lint Markdown files in the base directory of a project:

- uses: DavidAnson/markdownlint-cli2-action@v9

To lint all Markdown files in a project:

- uses: DavidAnson/markdownlint-cli2-action@v9
  with:
    globs: '**/*.md'

To lint specific Markdown files in a project:

- uses: DavidAnson/markdownlint-cli2-action@v9
  with:
    globs: |
      README.md
      CHANGELOG.md
      docs/*.md

To use a custom separator:

- uses: DavidAnson/markdownlint-cli2-action@v9
  with:
    globs: 'README.md,CHANGELOG.md,docs/*.md'
    separator: ','

To fix supported issues when linting:

- uses: DavidAnson/markdownlint-cli2-action@v9
  with:
    command: fix
    globs: '**/*.md'

To specify a custom configuration file:

- uses: DavidAnson/markdownlint-cli2-action@v9
  with:
    command: config
    globs: |
      config/custom.markdownlint.jsonc
      **/*.md

To prevent linting issues from failing the workflow run:

- uses: DavidAnson/markdownlint-cli2-action@v9
  continue-on-error: true

See example.yml for a simple GitHub workflow that uses markdownlint-cli2-action.

See changed.yml for a GitHub workflow that lints only the Markdown files that changed in the most recent commit (useful for Pull Requests and/or gradually introducing linting rules to a new repository).