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
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. 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. |
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 |
Example
{
"type": "github/file",
"reference": "https://api.github.com/repos/baxterthehacker/public-repo/contents/path/to/file.yml",
"name": "path/to/file.yml",
"version": "aec855f4e0e11"
}