civis (version 3.0.0)

reports_put_git: Attach an item to a file in a git repo

Description

Attach an item to a file in a git repo

Usage

reports_put_git(
  id,
  git_ref = NULL,
  git_branch = NULL,
  git_path = NULL,
  git_repo_url = NULL,
  pull_from_git = NULL
)

Value

A list containing the following elements:

gitRef

string, A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.

gitBranch

string, The git branch that the file is on.

gitPath

string, The path of the file in the repository.

gitRepo

list, A list containing the following elements:

• id integer, The ID for this git repository.

• repoUrl string, The URL for this git repository.

• createdAt string,

• updatedAt string,

pullFromGit

boolean, Automatically pull latest commit from git. Only works for scripts.

Arguments

id

integer required. The ID of the file.

git_ref

string optional. A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.

git_branch

string optional. The git branch that the file is on.

git_path

string optional. The path of the file in the repository.

git_repo_url

string optional. The URL of the git repository.

pull_from_git

boolean optional. Automatically pull latest commit from git. Only works for scripts.