android-lint-statistics

Generate android lint statistics action

This action generate some chart image and report file:

data transition	severity	priority

v2 was released, but it is not debugging. If you have some problem, please report issue

Required

• This action can execute only linux runner
• Install dependencies before executing this action
  • sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
  • Because Automattic/node-canvas is required

Example

Simple example your android project repository, using MeilCli/slack-upload-file to notify slack

name: CI

on:
  workflow_dispatch:

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-java@v1
        with:
          java-version: 1.8
      - name: Grant permission
        run: chmod +x gradlew
      - name: Run lint
        run: ./gradlew lintDebug
      - name: install for canvas
        run: sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
      - uses: MeilCli/android-lint-statistics@v2
        with:
          lint_xml_file_path: 'reports/lint/**/**.xml' # change your lint result path
      - uses: MeilCli/slack-upload-file@v1
        with:
          slack_token: ${{ secrets.SLACK_TOKEN }}
          channels: ${{ secrets.SLACK_CHANNELS }}
          file_path: 'report.txt'
          file_name: 'report.txt'
          file_type: 'text' 
      - uses: MeilCli/slack-upload-file@v1
        with:
          slack_token: ${{ secrets.SLACK_TOKEN }}
          channels: ${{ secrets.SLACK_CHANNELS }}
          file_path: 'data.png'
          file_name: 'data.png'
          file_type: 'png'
      - uses: MeilCli/slack-upload-file@v1
        with:
          slack_token: ${{ secrets.SLACK_TOKEN }}
          channels: ${{ secrets.SLACK_CHANNELS }}
          file_path: 'severity.png'
          file_name: 'severity.png'
          file_type: 'png'
      - uses: MeilCli/slack-upload-file@v1
        with:
          slack_token: ${{ secrets.SLACK_TOKEN }}
          channels: ${{ secrets.SLACK_CHANNELS }}
          file_path: 'priority.png'
          file_name: 'priority.png'
          file_type: 'png' 

You can also pin to a specific release version in the format @v1.x.x

Input

• repository
  • required
  • running repository, format: owner/repository
  • default: ${{ github.repository }}
• github_token
  • required
  • github token, using to push data branch
  • default: ${{ github.token }}
• lint_xml_file_path
  • required
  • android lint reported xml file paths, enable glob pattern
• lint_xml_file_path_follow_symbolic_links
  • required
  • android lint reported xml file paths glob pattern's follow symbolic links option
  • value: true or false
  • default: false
• data_branch
  • the saving data branch, this branch is created by this action. if want disable this feature, put empty string
  • default: data/lint
• data_commit_user
  • the saving data commit user
  • default: github-action
• data_commit_email
  • the saving data commit user's email
  • default: 41898282+github-actions[bot]@users.noreply.github.com
• data_json_file_path
  • the saving data json file path, this file is created at data branch
  • default: data.json
• data_chart_file_path
  • the data transition chart png image path, this file is created at your checkouted branch
  • default: data.png
• severity_chart_file_path
  • required
  • the severity chart png image path, this file is created at your checkouted branch
  • default: severity.png
• priority_chart_file_path
  • required
  • the priority chart png image path, this file is created at your checkouted branch
  • default: priority.png
• report_json_file_path
  • required
  • the report json file path, this file is created at your checkouted branch
  • default: report.json
• report_text_file_path
  • required
  • the report text file path, this file is created at your checkouted branch
  • default: report.txt

Attention!

This action auto create data branch and auto commit and push, because to create data transition chart image. Plese see data_branch input option

How execute windows or mac runner?

This action can execute only linux runner because @zeit/ncc aggregate node-canvas's binary. So, if you execute other runner, you do fork this repository and do npm run build && npm run pack on your runner.

How to run in a different repository than the target repository

In my case, double checkout repository on monitoring repository.

• target repository: Librarian
• monitoring repository: Librarian-monitoring

simple example:

name: CI

on:
  workflow_dispatch:

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/checkout@v2
        with:
          repository: 'MeilCli/Librarian'
          ref: 'master'
          path: 'Librarian'
      - uses: actions/setup-java@v1
        with:
          java-version: 1.8
      - name: Grant permission
        run: chmod +x Librarian/gradlew
      - name: Run lint
        run: cd Librarian && ./gradlew lintDebug
      - uses: MeilCli/android-lint-statistics@v1
        with:
          lint_xml_file_path: 'Librarian/reports/lint/**/**.xml'
      # generate paths:
      # - report.txt
      # - report.json
      # - data.png
      # - severity.png
      # - priority.png

Contributes

Could you want to contribute?

see Contributing.md

License

Using

• actions/toolkit, published by MIT License
• Automattic/node-canvas, published by MIT License
• chartjs/Chart.js, published by MIT License
• Leonidas-from-XIV/node-xml2js, published by MIT License