From 03b2b0d4847d917e4ab7580d70f2816f29edeede Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Fri, 21 Jul 2023 12:44:12 +0200 Subject: [PATCH] Add a shortcut to ensure that ./gradlew check will prevent having warning in the codebase. We may add more instructions in the future in this file. --- tools/quality/check.sh | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100755 tools/quality/check.sh diff --git a/tools/quality/check.sh b/tools/quality/check.sh new file mode 100755 index 0000000000..c3f87b3018 --- /dev/null +++ b/tools/quality/check.sh @@ -0,0 +1,30 @@ +#!/usr/bin/env bash + +# +# Copyright 2023 New Vector Ltd +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# List of tasks to run before creating a PR, to limit the risk of getting rejected by the CI. +# Can be used as a git hook if you want. + +# exit when any command fails +set -e + +# First run the quickest script +./tools/check/check_code_quality.sh + +# Build, test and check the project, with warning as errors +# It also check that the minimal app is compiling. +./gradlew check -PallWarningsAsErrors=true