You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
1.3 KiB
Bash
54 lines
1.3 KiB
Bash
#!/usr/bin/env bash
|
|
# vim:ts=4:sts=4:sw=4:et
|
|
#
|
|
# Author: Hari Sekhon
|
|
# Date: 2022-06-28 18:34:34 +0100 (Tue, 28 Jun 2022)
|
|
#
|
|
# https://github.com/HariSekhon/DevOps-Bash-tools
|
|
#
|
|
# License: see accompanying Hari Sekhon LICENSE file
|
|
#
|
|
# If you're using my code you're welcome to connect with me on LinkedIn and optionally send me feedback to help steer this or other code I publish
|
|
#
|
|
# https://www.linkedin.com/in/HariSekhon
|
|
#
|
|
|
|
# https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API
|
|
|
|
set -euo pipefail
|
|
[ -n "${DEBUG:-}" ] && set -x
|
|
srcdir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
|
|
# shellcheck disable=SC1090,SC1091
|
|
. "$srcdir/lib/utils.sh"
|
|
|
|
# shellcheck disable=SC2034,SC2154
|
|
usage_description="
|
|
Gets or Sets the description of a given Jenkins job/pipeline via the Jenkins API
|
|
|
|
Tested on Jenkins 2.319
|
|
|
|
Uses the adjacent jenkins_api.sh - see there for authentication details
|
|
"
|
|
|
|
# used by usage() in lib/utils.sh
|
|
# shellcheck disable=SC2034
|
|
usage_args="<job_name> [<description>]"
|
|
|
|
help_usage "$@"
|
|
|
|
min_args 1 "$@"
|
|
|
|
job="$1"
|
|
shift || :
|
|
description="$*"
|
|
|
|
if [ -n "$description" ]; then
|
|
"$srcdir/jenkins_api.sh" "/job/$job/description?description=$description" -X POST
|
|
timestamp "Set Jenkins job '$job' description to '$description'"
|
|
else
|
|
"$srcdir/jenkins_api.sh" "/job/$job/description"
|
|
# because there isn't a newline at the end
|
|
echo
|
|
fi
|