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.


Field Explanation
type Always github/file.
reference The full path including filename for retrieval via the GitHub API. This is the contents_url as referenced by a PushEvent. is an example for public GitHub. is an example for GHE.
name The file path within your repo. path/to/file.yml is an example.
version The file’s commit, branch, or tag.
location N/A


  "type": "github/file",
  "reference": "",
  "name": "path/to/file.yml",
  "version": "aec855f4e0e11"