Skip to content

CONTRIBUTING: update test command - #107

Open
alxndrsn wants to merge 1 commit into
getodk:masterfrom
alxndrsn:remove-lint-references
Open

alxndrsn wants to merge 1 commit into
getodk:masterfrom
alxndrsn:remove-lint-references

Conversation

@alxndrsn

@alxndrsn alxndrsn commented Nov 2, 2026

Copy link
Copy Markdown

Reference to lint gradle tasks removed, as the task does not exist.

What has been done to verify that this works as intended?

./gradlew lint
FAILURE: Build failed with an exception.

* What went wrong:
Task 'lint' not found in root project 'app'. Some candidates are: 'init'.

* Try:
Run gradlew tasks to get a list of available tasks. Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 2s
./gradlew tasks
> Task :tasks

------------------------------------------------------------
Tasks runnable from root project
------------------------------------------------------------

Application tasks
-----------------
run - Runs this project as a JVM application

Build tasks
-----------
assemble - Assembles the outputs of this project.
build - Assembles and tests this project.
buildDependents - Assembles and tests this project and all projects that depend on it.
buildNeeded - Assembles and tests this project and all projects it depends on.
classes - Assembles main classes.
clean - Deletes the build directory.
jar - Assembles a jar archive containing the main classes.
testClasses - Assembles test classes.

Build Setup tasks
-----------------
init - Initializes a new Gradle build.
wrapper - Generates Gradle wrapper files.

Distribution tasks
------------------
assembleDist - Assembles the main distributions
distTar - Bundles the project as a distribution.
distZip - Bundles the project as a distribution.
installDist - Installs the project as a distribution as-is.

Documentation tasks
-------------------
javadoc - Generates Javadoc API documentation for the main source code.

Help tasks
----------
buildEnvironment - Displays all buildscript dependencies declared in root project 'app'.
components - Displays the components produced by root project 'app'. [incubating]
dependencies - Displays all dependencies declared in root project 'app'.
dependencyInsight - Displays the insight into a specific dependency in root project 'app'.
dependentComponents - Displays the dependent components of components in root project 'app'. [incubating]
help - Displays a help message.
model - Displays the configuration model of root project 'app'. [incubating]
projects - Displays the sub-projects of root project 'app'.
properties - Displays the properties of root project 'app'.
tasks - Displays the tasks runnable from root project 'app'.

IDE tasks
---------
cleanIdea - Cleans IDEA project files (IML, IPR)
idea - Generates IDEA project files (IML, IPR, IWS)
openIdea - Opens the IDEA project

Verification tasks
------------------
check - Runs all checks.
test - Runs the unit tests.

Rules
-----
Pattern: clean<TaskName>: Cleans the output files of a task.
Pattern: build<ConfigurationName>: Assembles the artifacts of a configuration.
Pattern: upload<ConfigurationName>: Assembles and uploads the artifacts belonging to a configuration.

To see all tasks and more detail, run gradlew tasks --all

To see more detail about a task, run gradlew help --task <task>

BUILD SUCCESSFUL in 2s

Why is this the best possible solution? Were any other approaches considered?

Could add a lint task?

Are there any risks to merging this code? If so, what are they?

No - it's a documentation update.

Reference to `lint` gradle tasks removed, as the task does not exist.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant