Code Monkey home page Code Monkey logo

annotate-pull-request-from-checkstyle-action's Introduction

annotate-pull-request-from-checkstyle-action

annotate-pull-request-from-checkstyle-action is a GitHub Action that uses cs2pr to converts checkstyle XML files to GitHub PR annotations.

Context Example Images from https://github.com/mheap/phpunit-github-actions-printer

Usage

name: CS2PR
on:
  - pull_request

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - uses: staabm/annotate-pull-request-from-checkstyle-action@v1
        with:
          files: checkstyle.xml
          notices-as-warnings: true # optional

Action Inputs

  • files (Required) - The checkstyle XML files to convert to GitHub PR annotations separated by semicolons
  • graceful-warnings (Optional) - Don't exit with error codes if there are only warnings
    • Expected value: "true"
  • colorize (Optional) - Colorize the output (still compatible with Github Annotations)
    • Expected value: "true"
  • notices-as-warnings (Optional) - Convert notices to warnings (Github does not annotate notices otherwise)
    • Expected value: "true"
  • errors-as-warnings: (Optional) - Downgrade errors to warnings
    • Expected value: "true"
  • prepend-filename (Optional) - Prepend error 'filename' attribute to the message
    • Expected value: "true"
  • prepend-source (Optional) - Prepend error 'source' attribute to the message
    • Expected value: "true"

annotate-pull-request-from-checkstyle-action's People

Contributors

donatj avatar staabm avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

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.