diff --git a/script/openqa-verify-pr b/script/openqa-verify-pr index 2ab0a03efe7..b48fa18119a 100755 --- a/script/openqa-verify-pr +++ b/script/openqa-verify-pr @@ -1,32 +1,33 @@ #!/bin/bash -# Copyright 2024 (c) SUSE LLC +# Copyright 2024 SUSE LLC # SPDX-License-Identifier: GPL-2.0-or-later -# Schedule a verification run for a os-autoinst PR -# USAGE: +# OpenQA verification run scheduler # -# schedule_verification_run $SOURCE $PR_ID $BASE_TEST_ID $[test/module, test/module, ...] $TEST_NAME +# Usage: +# openqa-verify-pr $SOURCE $PR_ID $BASE_TEST_ID $[test/module, test/module,...] $TEST_NAME # -# Parameters +# Parameters: +# SOURCE - The source you want to schedule a run for. Can be either 'opensuse' or 'suse'. +# PR_ID - The ID of your GitHub pull request. +# BASE_TEST_ID - The ID of the test you want you use as a base. +# [test/module,...] - The modules of your test you want to schedule for. +# TEST_NAME - The Name of your test. (E.g.: TEST=RUST) # -# * $SOURCE - The source you want to schedule a rund for. Can be either opensuse or suse. -# * $PR_ID - The ID of your GitHub Pull Request. -# * $BASE_TEST_ID - The ID of the test you want you use as a base. -# * $[test/module, ...] - The modules of your test you want to schedule for. -# * $TEST_NAME - The Name of your test. (E.g.: TETS=RUST) +# Specify your GitHub access token in '~/.config/openqa/verification.conf' like this: # -# Specify your GitHub access token in a config file at '~/.config/openqa/gh.conf' like this: -# -# ``` # GH_ACCESS_TOKEN="YOUR_TOKEN_HERE" -# ``` # -# Default test modules +# To specify the URL to your own openQA instance specify it in the same config file like this: # -# The following modules are automatically selected to load for your run: +# CUSTOM_TARGET="https://openqa.yourdomain.com" # -# * 'tests/installation/bootloader_start' -# * 'tests/boot/boot_to_desktop' +# Default test modules +# 'tests/installation/bootloader_start' +# 'tests/boot/boot_to_desktop' +# +# Options: +# -h, --help Display this help text. # # Example # @@ -57,8 +58,6 @@ To specify the URL to your own openQA instance specify it in the same config fil CUSTOM_TARGET="https://openqa.yourdomain.com" Default test modules: -The following modules are automatically selected to load for your run: - 'tests/installation/bootloader_start' 'tests/boot/boot_to_desktop' @@ -73,7 +72,7 @@ set -o pipefail source=$1 pr_id=$2 test_id=$3 modules=$4 test_name=$5 config_file=$HOME/.config/openqa/verification.conf config= custom_target= -if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then +if [ $1 = '-h' ] || [ $1 = '--help' ]; then echo "$help_text" exit 0 fi