Namespace src/Web

Summary:
Documentation for src/Web directory
Created on:
Last updated:

src/Web

Overview

Directory src/Web

file source src/Web/getReleases.sh

Web::getReleases

Retrieve the latest version number of a web release

Arguments
  • $1 (releaseListUrl:String): the url from which version list can be retrieved
Environment variables
  • CURL_CONNECT_TIMEOUT (number): of seconds before giving up host connection
Output on stdout
  • log messages about retry

src/Web/upgradeRelease.sh

file source src/Web/upgradeRelease.sh

Web::upgradeRelease

upgrade given binary to latest release using retry

releasesUrl argument : the placeholder @latestVersion@ will be replaced by the latest release version

Arguments
  • $1 (targetFile:String): target binary file (eg: /usr/local/bin/kind)
  • $2 (releasesUrl:String): url on which we can query all available versions (eg: “https://go.dev/dl/?mode=json")
  • $3 (downloadReleaseUrl:String): url from which the software will be downloaded (eg: https://storage.googleapis.com/golang/go@latestVersion@.linux-amd64.tar.gz)
  • $4 (softVersionArg:String): parameter to add to existing command to compute current version
  • $5 (exactVersion:String): if you want to retrieve a specific version instead of the latest
Environment variables
  • FILTER_LAST_VERSION_CALLBACK (a): callback to filter the latest version from releasesUrl
  • SOFT_VERSION_CALLBACK (a): callback to execute command version
  • PARSE_VERSION_CALLBACK (a): callback to parse the version of the existing command
  • INSTALL_CALLBACK (a): callback to install the software downloaded
  • CURL_CONNECT_TIMEOUT (number): of seconds before giving up host connection
  • VERSION_PLACEHOLDER (a): placeholder to replace in downloadReleaseUrl (default: @latestVersion@)
Output on stdout
  • log messages about retry, install, upgrade
Or, if you want, you can alternatively use the GitHub discussion Q&A for feedback and questions.