Fetches and creates versioned GitHub resources.
If you're seeing rate limits affecting you then please add a token to the source configuration. This will increase your number of allowed requests.
-
owner: Required. The GitHub user or organization name for the repository that the releases are in. -
repository: Required. The repository name that contains the releases. -
access_token: Optional. Used for accessing a release in a private-repo during aninand pushing a release to a repo during anout. The access token you create is only required to have therepoorpublic_reposcope. -
github_api_url: Optional. If you use a non-public GitHub deployment then you can set your API URL here. -
github_v4_api_url: Optional. If you use a non-public GitHub deployment then you can set your API URL for graphql calls here. -
github_uploads_url: Optional. Some GitHub instances have a separate URL for uploading. Ifgithub_api_urlis set, this value defaults to the same value, but if you have your own endpoint, this field will override it. -
insecure: Optional. Defaultfalse. When set totrue, concourse will allow insecure connection to your github API. -
release: Optional. Defaulttrue. When set totrue,checkdetects final releases andputpublishes final releases (as opposed to pre-releases). Iffalse,checkwill ignore final releases, andputwill publish pre-releases ifpre_releaseis set totrue -
pre_release: Optional. Defaultfalse. When set totrue,checkdetects pre-releases, andputwill produce pre-releases (ifreleaseis also set tofalse). Iffalse, only non-prerelease releases will be detected and published.note: if both
releaseandpre_releaseare set totrue,putproduces final releases andcheckdetects both pre-releases and releases. In order to produce pre-releases, you must setpre_releasetotrueandreleasetofalse.
note: if bothreleaseandpre_releaseare set tofalse,putwill still produce final releases.
note: releases must have semver compliant tags to be detected. -
drafts: Optional. Defaultfalse. When set totrue,putproduces drafts andcheckonly detects drafts. Iffalse, only non-draft releases will be detected and published. Note that releases must have semver compliant tags to be detected, even if they're drafts. -
semver_constraint: Optional. If set, constrain the returned semver tags according to a semver constraint, e.g."~1.2.x",">= 1.2 < 3.0.0 || >= 4.2.3". Follows the rules outlined in https://github.com/Masterminds/semver#checking-version-constraints. -
tag_filter: Optional. If set, override default tag filter regular expression ofv?([^v].*). If the filter includes a capture group, the capture group is used as the release version; otherwise, the entire matching substring is used as the version. -
order_by: Optional. One of [version,time]. Defaultversion. Selects whether to order releases by version (as extracted bytag_filter) or by time. Seecheckbehavior described below for details.
- name: gh-release
type: github-release
source:
owner: concourse
repository: concourse
access_token: abcdef1234567890- get: gh-release- put: gh-release
params:
name: path/to/name/file
tag: path/to/tag/file
body: path/to/body/file
globs:
- paths/to/files/to/upload-*.tgz
generate_release_notes: trueTo get a specific version of a release:
- get: gh-release
version: { tag: 'v0.0.1' }To set a custom tag filter:
- name: gh-release
type: github-release
source:
owner: concourse
repository: concourse
tag_filter: "version-(.*)"Lists releases, sorted either by their version or time, depending on the order_by source option.
When sorting by version, the version is extracted from the git tag using the tag_filter source option.
Versions are compared using semver semantics if possible.
When sorting by time and a release is published, it uses the publication time, otherwise it uses the creation time.
The returned list contains an object of the following format for each release (with timestamp in the RFC3339 format):
{
"id": "12345",
"tag": "v1.2.3",
"timestamp": "2006-01-02T15:04:05.999999999Z"
}
When check is given such an object as the version parameter, it returns releases from the specified version or time on.
Otherwise it returns the release with the latest version or time.
Fetches artifacts from the requested release.
Also creates the following files:
tagcontaining the git tag name of the release being fetched.versioncontaining the version determined by the git tag of the release being fetched.bodycontaining the body text of the release.timestampcontaining the publish or creation timestamp for the release in RFC 3339 format.commit_shacontaining the commit SHA the tag is pointing to.urlcontaining the HTMLURL for the release being fetched.
-
globs: Optional. A list of globs for files that will be downloaded from the release. If not specified, all assets will be fetched. -
include_source_tarball: Optional. Enables downloading of the source artifact tarball for the release assource.tar.gz. Defaults tofalse. -
include_source_zip: Optional. Enables downloading of the source artifact zip for the release assource.zip. Defaults tofalse.
Given a name specified in name, a body specified in body, and the tag to use
specified in tag, this creates a release on GitHub then uploads the files
matching the patterns in globs to the release.
-
name: Required. A path to a file containing the name of the release. -
tag: Required. A path to a file containing the name of the Git tag to use for the release. -
tag_prefix: Optional. If specified, the tag read from the file will be prepended with this string. This is useful for adding v in front of version numbers. -
commitish: Optional. A path to a file containing the commitish (SHA, tag, branch name) that the release should be associated with. -
body: Optional. A path to a file containing the body text of the release. -
globs: Optional. A list of globs for files that will be uploaded alongside the created release. -
generate_release_notes: Optional. Causes GitHub to autogenerate the release notes when creating a new release, based on the commits since the last release. Ifbodyis specified, the body will be pre-pended to the automatically generated notes. Has no effect when updating an existing release. Defaults tofalse.
- golang is required - version 1.15.x is tested; earlier versions may also work.
- docker is required - version 17.06.x is tested; earlier versions may also work.
The tests have been embedded with the Dockerfile; ensuring that the testing
environment is consistent across any docker enabled platform. When the docker
image builds, the test are run inside the docker container, on failure they
will stop the build.
Run the tests with the following command:
docker build -t github-release-resource --target tests --build-arg base_image=concourse/resource-types-base-image-static:latest .Please make all pull requests to the master branch and ensure tests pass
locally.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent