Skip to content

Commit 1ef53e3

Browse files
BanyikAnnagodrei
authored andcommitted
step description updates (#15)
* step description updates * corrections added Related Steps links * formatting added unordered list to Useful links and Related Steps
1 parent 3830df1 commit 1ef53e3

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

step.yml

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
1-
title: Android Lint
2-
summary: This step runs lint gradle task on your project.
3-
description: This step runs lint gradle task on your project.
1+
title: "Android Lint"
2+
summary: |-
3+
Runs Lint on your Android project source files and detects potential syntax errors to keep your code error free.
4+
description: |-
5+
It highlights the code line where the error is found, explains the type of error and suggests corrections. The Step does not make the build fail if it spots any structural errors in your code. If you have inserted the **Deploy to Bitrise.io** Step in the Workflow, the tes results will be available in a viewable or downloadable Lint Report HTML or XML file which you can access on the Build's APPS & ARTIFACTS page.
6+
7+
### Configuring the Step
8+
9+
1. Set the **Project Location** input which, by default, points to the root directory of your Android project.
10+
2. Set the module and variant you wish to lint in the **Module** and **Variant** fields.
11+
12+
Optionally, you can modify these inputs:
13+
1. You can specify where the Lint reports should be found once the Step has run if you overwrite the **Report location pattern** input.
14+
2. You can set if the Step should cache build outputs and dependencies, only the dependencies or nothing at all in the **Set level of cache** input.
15+
3. You can set any gradle argument to the gradle task in the **Additional Gradle Arguments** input.
16+
17+
### Troubleshooting
18+
Make sure you insert the Step before a build Step.
19+
Make sure you type the correct module and variant names in the respective fields of the Step. If you are unsure about the exact names, you can check them in the **Project Structure** dialog of your project in Android Studio.
20+
21+
### Useful links
22+
- [Improve your code with lint checks](https://developer.android.com/studio/write/lint)
23+
24+
### Related Steps
25+
- [Android Build](https://www.bitrise.io/integrations/steps/android-build)
26+
- [Android Unit Test](https://www.bitrise.io/integrations/steps/android-unit-test)
27+
- [[BETA] Virtual Device Testing for Android](https://www.bitrise.io/integrations/steps/virtual-device-testing-for-android)
428
website: https://github.com/bitrise-steplib/bitrise-step-android-lint
529
source_code_url: https://github.com/bitrise-steplib/bitrise-step-android-lint
630
support_url: https://github.com/bitrise-steplib/bitrise-step-android-lint/issues

0 commit comments

Comments
 (0)