reviewdog / action-markdownlint Goto Github PK

View Code? Open in Web Editor NEW

18.0 31.0 12.0 92 KB

Run markdownlint with reviewdog

License: MIT License

Dockerfile 32.27% Shell 67.73%

reviewdog markdown markdownlint

action-markdownlint's Introduction

GitHub Action: Run markdownlint with reviewdog

Based on reviewdog/action-shellcheck

This action runs markdownlint with reviewdog on pull requests to improve code review experience.

Inputs

inputs:
  github_token:
    description: 'GITHUB_TOKEN.'
    default: '${{ github.token }}'
  ### Flags for reviewdog ###
  level:
    description: 'Report level for reviewdog [info,warning,error]'
    default: 'error'
  reporter:
    description: 'Reporter of reviewdog command [github-check,github-pr-review].'
    default: 'github-check'
  filter_mode:
    description: |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default: 'added'
  fail_on_error:
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default: 'false'
  reviewdog_flags:
    description: 'Additional reviewdog flags'
    default: ''
  ### Flags for markdownlint-cli ###
  markdownlint_flags:
    description: "Options of markdownlint-cli command. Default: '.'"
    default: '.'

Example usage

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  markdownlint:
    name: runner / markdownlint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: markdownlint
        uses: reviewdog/action-markdownlint@v0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-review

action-markdownlint's People

Contributors

Stargazers

Watchers

Forkers

fkohrt tsuyoshicho markcmurphy msherman64 updater oscar-dominguez syllogy easimon fgrehm blooper05 uber-evaluation hituzi-no-sippo

action-markdownlint's Issues

Fails to run on GitHub Actions

reviewdog/reviewdog#1158 - See this for more information, markdownlint running on GH Actions throws this error as well:

reviewdog: PullRequest needs 'git' command: failed to run 'git rev-parse --show-prefix': exit status 128

How to specify markdownlint flags?

Could you provide an example of how the MDL config should be formatted? Like this?

- name: markdownlint
  uses: reviewdog/action-markdownlint@master
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    reporter: github-pr-review
    markdownlint_flags:
      MD013: false

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

dockerfile

Dockerfile

node 20-bullseye-slim

github-actions

.github/workflows/depup.yml

actions/checkout v4

haya14busa/action-depup v1

peter-evans/create-pull-request v6

actions/checkout v4

haya14busa/action-depup v1

peter-evans/create-pull-request v6

.github/workflows/dockerimage.yml

actions/checkout v4

.github/workflows/release.yml

actions/checkout v4

haya14busa/action-bumpr v1

haya14busa/action-update-semver v1

haya14busa/action-cond v1

actions/checkout v4

haya14busa/action-bumpr v1

.github/workflows/reviewdog.yml

actions/checkout v4

Check this box to trigger a request for Renovate to run again on this repository

Use other maintained or custom docker image with freshier node version

The current base image prologic/markdownlint was lastly updated a year ago and the link to its GitHub repo is dead - so it seems like this image is no longer maintained.
The problem is that it contains node version 13.13.0 which is quite old - what do you think about creating a custom Dockerfile based on the node image?

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Action creates an empty report

The job outputs the findings of markdownlint, but the report by reviewdog does not contain any finding.

Example:
https://github.com/Rotzbua/test_markdownlint/runs/1625711973

Action stopped working

Great action - Thanks!

Starting today, I'm getting this message.
No modifications were made on my end, of course, this started happening today out-of-the-blue.

reviewdog: cannot get repo owner from environment variable. Set CI_REPO_OWNER?

This is my configuration:

      - name: Lint markdown files
        uses: prologic/[email protected]
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-check
          level: error

Any thoughts on the manner please?

How to pass multiple parameters to markdownlint-cli?

When I write:

- name: markdownlint-github-pr-review
  uses: reviewdog/action-markdownlint@v0
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    fail_on_error: true
    filter_mode: added
    reporter: github-pr-review
    markdownlint_flags: content/**/*.md

It works.
But if I add ignore parameter, so it's failing:

- name: markdownlint-github-pr-review
  uses: reviewdog/action-markdownlint@v0
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    fail_on_error: true
    filter_mode: added
    reporter: github-pr-review
    markdownlint_flags: -i **/template_*.md content/**/*.md

it's not working? What am I missing?