Giter Site home page Giter Site logo

xt0rted / markdownlint-problem-matcher Goto Github PK

View Code? Open in Web Editor NEW
9.0 4.0 3.0 2.34 MB

A GitHub Action that registers a problem matcher for markdownlint-cli's report format

License: MIT License

TypeScript 82.67% JavaScript 17.33%
github-actions markdownlint linting problem-matcher annotations

markdownlint-problem-matcher's Introduction

Problem Matcher for markdownlint-cli

CI CodeQL

Adds a problem matcher that will detect errors from markdownlint-cli and create annotations for them.

Usage

on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: xt0rted/markdownlint-problem-matcher@v3
      - run: markdownlint **/*.md --ignore node_modules

Options

Name Allowed values Description
action add (default), remove If the problem matcher should be registered or removed

License

The scripts and documentation in this project are released under the MIT License

markdownlint-problem-matcher's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

vutting4221 arbiv

markdownlint-problem-matcher's Issues

How to use this GitHub action?

Hi there,

I tried to use this GitHub Action, as specified:

on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: xt0rted/markdownlint-problem-matcher@v1
      - run: markdownlint **/*.md --ignore node_modules

But when the action runs, I get the error:

line 1: markdownlint: command not found

So I suspect I must be doing something completely wrong?

Is it intentional that the v1.0.0 tag is not usable in workflows?

Hi,

I was hoping to use the most specific version of the action (i.e. v1.0.0) in my workflow since I like to keep things as stable/non-disruptive as possible. But it seems that that tag isn't meant to be consumed in workflows as it lacks the dist directory.

I just wanted to check if this is intentional?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.