yutailang0119 / action-android-lint

GitHub Action for Android Lint

GitHub Action for Android Lint

This Action generates annotations from Android Lint Report XML.

Usage

An example workflow(.github/workflows/android-lint.yml) to executing Android Lint follows:

name: AndroidLint

on:
  pull_request:
    paths:
      - .github/workflows/android-lint.yml
      - '*/src/**'
      - gradle/**
      - '**.gradle'
      - gradle.properties
      - gradlew*

jobs:
  android-lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 1
      - name: set up JDK
        uses: actions/setup-java@v4
        with:
          distribution: zulu
          java-version: 21
          cache: gradle
      - run: ./gradlew lint
      - uses: yutailang0119/action-android-lint@v4
        with:
          report-path: build/reports/*.xml # Support glob patterns by https://www.npmjs.com/package/@actions/glob
          ignore-warnings: true # Ignore Lint Warnings
        continue-on-error: false # If annotations contain error of severity, action-android-lint exit 1.

Author

Yutaro Muta

References

• Generated from actions/typescript-action as template.
• This refer to mobileposse/github-android-lint-action.

License

action-android-lint is available under the MIT license. See the LICENSE file for more info.

action-android-lint's Issues

Adopts standard input syntax for GitHub Actions

Current

in action.yml

• xml_path
• follow-symbolic-links

refs

• lowerCamelCase: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
• kebab-case: https://github.com/actions/cache/blob/main/action.yml
• snake_case: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith

Support glob for xml_path

I'm currently adding this action to a project of mine and I looking at the code the xml_path does not support globbing. It would be nice if we could specify **/lint-results.xml as path for Gradle projects with multiple Android modules.

Can this action take multiple file paths?

I'm looking to use this action with multi-level projects, is there a way to declare one to many xml file paths in the "with" option of the action call?

Wildcards in XML path

It would be nice to have wildcards in 'xml_path':

- name: Generate Lint Annotations
  uses: yutailang0119/[email protected]
  with:
    xml_path: '**/build/reports/lint-results-*.xml'

Wildcards should be compatible with workflow syntax:

• *: Matches zero or more characters, but does not match the / character.
• **: Matches zero or more of any character.

Currently, it is necessary to provide a specific path, e.g.:

- name: Generate Lint Annotations
  uses: yutailang0119/[email protected]
  with:
    xml_path: ${{ github.workspace }}/app/build/reports/lint-results-debug.xml

more documentation needed

"This Action generates annotations from Android Lint Report XML."
does not adequately convey what this action does.

What is annotated and where are these annotations stored?

Action only fails if all specified reports contain errors

The action isn't failing as expected on specifying two reports, and only one of them contains errors and warnings.

I have set up a repository for demonstrating the issue. https://github.com/ashutoshgngwr/action-android-lint-test

Commit	Description	Expected result	Actual result
ashutoshgngwr/action-android-lint-test@a6cc623	Both the Lint reports contain errors	Exit with an error	Exited with an error
ashutoshgngwr/action-android-lint-test@d09228b	One of the two Lint reports contains errors	Exit with an error	Exited without an error

README example usage potential misspell

In the README.md line 38, on the section

- run: ./gradlew lint
- uses: yutailang0119/action-android-lint@v1

Is the second - needed right before the "uses"? All other actions I've seen don't have that, so I am assuming this is a simple misspell? If yes it'd be great to remove it, if no then what is the purpose of it?

Does it support multiple lint reports in xmlPath?

I have an app that has multiple modules. How would I pass lint results for different modules in xmlPath? Does it support wild cards?

Add flag to report only errors

It would be useful to have an ability to ignore warnings in the lint report and create annotations only for errors