Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Latest commit

 

History

History
165 lines (106 loc) · 6.98 KB

reference.md

File metadata and controls

165 lines (106 loc) · 6.98 KB

Reference

This document is a reference of all provided classes.

Resources

Cron

Upstream resource documentation: https://gitlab.com/phil9909/concourse-cron-resource/-/blob/master/README.md

Note: The location (used for timezone) is currently hardcoded to "Europe/Berlin".

Example:

Cron("0 0 4 * * *")

DockerImage

Upstream resource documentation: https://github.com/concourse/docker-image-resource/blob/master/README.md

Note: Only repository, username, password and tag are currently supported supported in source configuration.

Example:

DockerImage("alpine")

After getting the resource the following methods are available:

method returns locally
name the given name the given name
path the location where concourse stored the resource unavailable
digest() the pulled image digest "latest"

GoogleCloudStorageResource

Upstream resource documentation: https://github.com/frodenas/gcs-resource/blob/master/README.md

Note: versioned_file is currently unsupported.

Example:

GoogleCloudStorageResource("my-bucket", "(.*).txt", "((MY_GCS_CREDENTIALS))")

GitRepo

Upstream resource documentation: https://github.com/concourse/git-resource/blob/master/README.md

Note: Only uri, username, password, branch, ignore_paths, tag_filter, fetch_tags, git_config and private_key are currently supported supported in source configuration.

Example:

GitRepo("https://github.com/torvalds/linux")

After getting the resource the following methods are available:

method returns locally
name the given name the given name
path the location where concourse stored the resource ~/workspace/<name>
directory() the location where concourse stored the resource ~/workspace/<name>
tag() result of git describe --tags result of git describe --tags
ref() see upstream documentation result of git describe --tags if successful else git rev-parse HEAD
short_ref() see upstream documentation result of git rev-parse --short HEAD

GithubRelease

Upstream resource documentation: https://github.com/concourse/github-release-resource/blob/master/README.md

Note: Only owner, repo, access_token, pre_release, release, github_api_url and github_uploads_url are currently supported supported in source configuration.

Example:

GithubRelease(owner="concourse", repo="concourse")

After getting the resource the following methods are available:

method returns locally
name the given name the given name
path the location where concourse stored the resource unavailable
tag(default=None) see upstream documentation the default value passed to the method

ConcourseLockResource

Upstream resource documentation: https://github.com/concourse/pool-resource/blob/master/README.md

Note: Only uri, branch, pool, username and password are currently supported supported in source configuration.

Example:

ConcourseLockResource("https://github.com/concourse/locks", username="((GITHUB_USER))", password="((GITHUB_TOKEN))", branch="master", pool="my-pool")

SemVer

Upstream resource documentation: https://github.com/concourse/semver-resource/blob/master/README.md

Example:

SemVer(source=<see below>, initial_version="0.42.0")

After getting the resource the following methods are available:

method returns locally
name the given name the given name
path the location where concourse stored the resource unavailable
version() see upstream documentation "0.0.1"

Note: Currently, git is the only supported driver.

SemVerGitDriver

Note: Only owner, repo, access_token, pre_release, release, github_api_url and github_uploads_url are currently supported supported in source configuration.

Example:

 SemVer(source = SemVerGitDriver("https://github.com/concourse/version", username="((GITHUB_USER))", password="((GITHUB_TOKEN))", branch="version", file="version"))

RegistryImage

Upstream resource documentation: https://github.com/concourse/registry-image-resource/blob/master/README.md

Note: Only repo, user, password, tag and variant are currently supported in source configuration.

Example:

RegistryImage("deploy-releases.docker.repositories.sap.ondemand.com/com.sap.cloud/sb-proxy-cf-sap", "((REGISTRY_USER))", "((REGISTRY_TOKEN))")

GithubPR

Upstream resource documentation: https://github.com/telia-oss/github-pr-resource/blob/master/README.md

Example:

GithubPR(repository="torvalds/linux", access_token="((GITHUB_TOKEN))")

After getting the resource the following methods are available:

method returns locally
name the given name the given name
path the location where concourse stored the resource unavailable
version() parsed content of .git/resource/version.json the default value passed to the method
metadata() parsed content of .git/resource/metadata.json the default value passed to the method
changed_files() array of changed files parsed from .git/resource/changed_files the default value passed to the method