Remark GitHub Action

Table of Contents

• About the Project
• Usage
• Contributing
• License
• Credits

📄 About

remarklint as GitHub Action.

🚀 Usage

Add the a workflow file in your repository: .github/workflows/remark.yml.

on: push
name: Remark Lint
jobs:
  remark:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Running Remark
        uses: ocular-d/action-remark@0.0.10
        with:
          check_dir: 'md'

      - name: Create Issue
        if: ${{ steps.remark.outputs.exit_code }}
        uses: peter-evans/create-issue-from-file@v2
        with:
          title: Report
          content-filepath: error.log
          labels: report, automated issue

      - name: Fail if there were lint errors
        run: exit ${{ steps.remark.outputs.exit_code }}

🤝 Contributing

We are a community effort, and everybody is most welcome to participate!

Be it filing bugs, formulating enhancements, creating pull requests, or any other means of contribution, we encourage contributions from everyone.

📝 License

Distributed under the MIT license.