Interface UpdateFileOptions

UpdateFileOptions options for updating files Note: author and committer are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

Hierarchy

  • UpdateFileOptions

Properties

author? branch? committer? content dates? from_path? message? new_branch? sha signoff?

Properties

Optional author

author?: Identity

Identity for a person's identity like an author or committer

Optional branch

branch?: string

branch (optional) to base this file from. if not given, the default branch is used

Optional committer

committer?: Identity

Identity for a person's identity like an author or committer

content

content: string

content must be base64 encoded

Optional dates

dates?: CommitDateOptions

CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE

Optional from_path

from_path?: string

from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL

Optional message

message?: string

message (optional) for the commit of this file. if not supplied, a default message will be used

Optional new_branch

new_branch?: string

new_branch (optional) will make a new branch from branch before creating the file

sha

sha: string

sha is the SHA for the file that already exists

Optional signoff

signoff?: boolean

Add a Signed-off-by trailer by the committer at the end of the commit log message.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc