├── Dockerfile ├── LICENSE.txt ├── README.md ├── action.yml ├── converter.py └── entrypoint.sh /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.11 2 | 3 | RUN apk --no-cache --update add git python3 \ 4 | && rm -rf /var/cache/apk/* 5 | 6 | RUN wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s 7 | 8 | COPY entrypoint.sh /entrypoint.sh 9 | COPY converter.py /usr/local/bin/converter.py 10 | 11 | ENTRYPOINT ["/entrypoint.sh"] 12 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020 ScaCap 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GitHub Action: Run Android Lint with reviewdog 2 | 3 | This action runs [Android Lint](https://developer.android.com/studio/write/lint) with 4 | [reviewdog](https://github.com/reviewdog/reviewdog). 5 | 6 | ## Inputs 7 | 8 | #### `github_token` 9 | 10 | **Required**. Must be in form of `github_token: ${{ secrets.github_token }}`. 11 | 12 | #### `lint_xml_file` 13 | 14 | **Required**. Location of Android Lint XML file. 15 | 16 | #### `level` 17 | 18 | Optional. Report level for reviewdog [`info`,`warning`,`error`]. 19 | It's same as `-level` flag of reviewdog. 20 | The default is `error`. 21 | 22 | #### `reporter` 23 | 24 | Optional. Reporter of reviewdog command [`github-check`, `github-pr-check`,`github-pr-review`]. 25 | The default is `github-check`. 26 | 27 | #### `reviewdog_flags` 28 | 29 | Optional. Additional flags to be passed to reviewdog cli. 30 | The default is ``. 31 | 32 | ## Example usage 33 | 34 | [Example repo](https://github.com/DVDAndroid/action-android-lint-example) 35 | 36 | ```yml 37 | name: CI 38 | 39 | on: [push, pull_request] 40 | 41 | jobs: 42 | build: 43 | name: CI Build 44 | runs-on: ubuntu-latest 45 | 46 | steps: 47 | - name: Checkout repository 48 | uses: actions/checkout@master 49 | 50 | - name: Setup JDK 8 51 | uses: actions/setup-java@master 52 | with: 53 | java-version: 8 54 | 55 | - name: Grant execute permission for gradlew 56 | run: chmod +x gradlew 57 | 58 | - name: Run Gradle build 59 | run: ./gradlew build 60 | 61 | - name: Run Android Lint 62 | uses: dvdandroid/action-android-lint@master 63 | with: 64 | github_token: ${{ secrets.GITHUB_TOKEN }} 65 | lint_xml_file: app/build/reports/lint-results.xml 66 | ``` 67 | 68 | Note: `lint-results.xml` must be available; you need to `gradlew build` your application first 69 | 70 | ### Credits 71 | 72 | I used [ScaCap/action-ktlint](https://github.com/ScaCap/action-ktlint) as a template 73 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Run AndroidLint with reviewdog' 2 | description: 'Run AndroidLint with reviewdog' 3 | author: 'dvdandroid' 4 | 5 | inputs: 6 | github_token: 7 | description: 'GITHUB_TOKEN' 8 | required: true 9 | 10 | lint_xml_file: 11 | description: 'Path of Android Lint XML file' 12 | required: true 13 | 14 | level: 15 | description: 'Report level for reviewdog [info, warning, error]' 16 | required: false 17 | default: 'error' 18 | 19 | reporter: 20 | description: | 21 | Reporter of reviewdog command [github-check, github-pr-check, github-pr-review]. 22 | Default is github-check. 23 | required: false 24 | default: 'github-check' 25 | 26 | reviewdog_flags: 27 | description: 'Additional reviewdog flags' 28 | required: false 29 | default: '' 30 | 31 | runs: 32 | using: 'docker' 33 | image: 'Dockerfile' 34 | args: 35 | - ${{ inputs.github_token }} 36 | - ${{ inputs.lint_xml_file }} 37 | - ${{ inputs.level }} 38 | - ${{ inputs.reporter }} 39 | - ${{ inputs.reviewdog_flags }} 40 | 41 | branding: 42 | icon: 'smartphone' 43 | color: 'green' 44 | -------------------------------------------------------------------------------- /converter.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | import xml.etree.ElementTree as ET 4 | 5 | if len(sys.argv) == 1: 6 | raise NameError('No lint file specified') 7 | 8 | if not os.path.isfile(sys.argv[1]): 9 | raise IOError('Invalid file specified') 10 | 11 | RUNNER_WORKSPACE = os.environ['RUNNER_WORKSPACE'] 12 | REPO_NAME = os.environ['GITHUB_REPOSITORY'].split('/')[1] 13 | 14 | checkstyle = ET.Element('checkstyle') 15 | checkstyle.attrib['version'] = '8.0' 16 | 17 | for issue in ET.parse(sys.argv[1]).getroot().iter('issue'): 18 | file = ET.SubElement(checkstyle, 'file') 19 | 20 | if '.gradle/caches' in issue[0].attrib['file']: 21 | continue 22 | 23 | file.attrib['name'] = issue[0].attrib['file'].replace(f'{RUNNER_WORKSPACE}/{REPO_NAME}/', '') 24 | 25 | error = ET.SubElement(file, 'error') 26 | 27 | if 'line' in issue[0].attrib: 28 | error.attrib['line'] = issue[0].attrib['line'] 29 | else: 30 | error.attrib['line'] = str(0) 31 | 32 | if 'column' in issue[0].attrib: 33 | error.attrib['column'] = issue[0].attrib['column'] 34 | else: 35 | error.attrib['column'] = str(0) 36 | 37 | if 'severity' in issue.attrib: 38 | error.attrib['severity'] = issue.attrib['severity'] 39 | else: 40 | error.attrib['severity'] = 'info' 41 | 42 | issueId = issue.attrib['id'] 43 | message = issue.attrib['message'] 44 | error.attrib['message'] = f'{issueId}: {message}' 45 | 46 | checkStyleFile = ET.ElementTree(checkstyle) 47 | checkStyleFile.write('output_checkstyle.xml') 48 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | export REVIEWDOG_GITHUB_API_TOKEN="${INPUT_GITHUB_TOKEN}" 4 | 5 | python3 /usr/local/bin/converter.py $GITHUB_WORKSPACE/${INPUT_LINT_XML_FILE} 6 | cat output_checkstyle.xml | reviewdog -f=checkstyle -name="Android Lint" -reporter="${INPUT_REPORTER}" -level="${INPUT_LEVEL}" ${INPUT_REVIEWDOG_FLAGS} 7 | --------------------------------------------------------------------------------