GitHub File

GitHub file artifacts are references to files stored in GitHub or GitHub Enterprise . They are generally consumed by stages that read configuration from text files, such as a Deploy Manifest stage.

Fields

FieldExplanation
typeAlways github/file.
referenceThe full path including filename for retrieval via the GitHub API. This is the contents_url as referenced by a PushEvent . https://api.github.com/repos/baxterthehacker/public-repo/contents/path/to/file.yml is an example for public GitHub. https://github.mydomain.com/api/v3/repos/orgname/reponame/contents/path/to/file.yml is an example for GHE.
nameThe file path within your repo. path/to/file.yml is an example.
versionThe file’s commit, branch, or tag.
locationN/A

Example

  1. {
  2. "type": "github/file",
  3. "reference": "https://api.github.com/repos/baxterthehacker/public-repo/contents/path/to/file.yml",
  4. "name": "path/to/file.yml",
  5. "version": "aec855f4e0e11"
  6. }

Last modified January 1, 0001