Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Creates a commit for a repository on the tip of a specified branch.
Synopsis
- data CreateCommit = CreateCommit' {}
- newCreateCommit :: Text -> Text -> CreateCommit
- createCommit_setFileModes :: Lens' CreateCommit (Maybe [SetFileModeEntry])
- createCommit_email :: Lens' CreateCommit (Maybe Text)
- createCommit_authorName :: Lens' CreateCommit (Maybe Text)
- createCommit_parentCommitId :: Lens' CreateCommit (Maybe Text)
- createCommit_deleteFiles :: Lens' CreateCommit (Maybe [DeleteFileEntry])
- createCommit_putFiles :: Lens' CreateCommit (Maybe [PutFileEntry])
- createCommit_commitMessage :: Lens' CreateCommit (Maybe Text)
- createCommit_keepEmptyFolders :: Lens' CreateCommit (Maybe Bool)
- createCommit_repositoryName :: Lens' CreateCommit Text
- createCommit_branchName :: Lens' CreateCommit Text
- data CreateCommitResponse = CreateCommitResponse' {
- commitId :: Maybe Text
- treeId :: Maybe Text
- filesAdded :: Maybe [FileMetadata]
- filesUpdated :: Maybe [FileMetadata]
- filesDeleted :: Maybe [FileMetadata]
- httpStatus :: Int
- newCreateCommitResponse :: Int -> CreateCommitResponse
- createCommitResponse_commitId :: Lens' CreateCommitResponse (Maybe Text)
- createCommitResponse_treeId :: Lens' CreateCommitResponse (Maybe Text)
- createCommitResponse_filesAdded :: Lens' CreateCommitResponse (Maybe [FileMetadata])
- createCommitResponse_filesUpdated :: Lens' CreateCommitResponse (Maybe [FileMetadata])
- createCommitResponse_filesDeleted :: Lens' CreateCommitResponse (Maybe [FileMetadata])
- createCommitResponse_httpStatus :: Lens' CreateCommitResponse Int
Creating a Request
data CreateCommit Source #
See: newCreateCommit
smart constructor.
CreateCommit' | |
|
Instances
Create a value of CreateCommit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:setFileModes:CreateCommit'
, createCommit_setFileModes
- The file modes to update for files in this commit.
$sel:email:CreateCommit'
, createCommit_email
- The email address of the person who created the commit.
$sel:authorName:CreateCommit'
, createCommit_authorName
- The name of the author who created the commit. This information is used
as both the author and committer for the commit.
$sel:parentCommitId:CreateCommit'
, createCommit_parentCommitId
- The ID of the commit that is the parent of the commit you create. Not
required if this is an empty repository.
$sel:deleteFiles:CreateCommit'
, createCommit_deleteFiles
- The files to delete in this commit. These files still exist in earlier
commits.
$sel:putFiles:CreateCommit'
, createCommit_putFiles
- The files to add or update in this commit.
$sel:commitMessage:CreateCommit'
, createCommit_commitMessage
- The commit message you want to include in the commit. Commit messages
are limited to 256 KB. If no message is specified, a default message is
used.
$sel:keepEmptyFolders:CreateCommit'
, createCommit_keepEmptyFolders
- If the commit contains deletions, whether to keep a folder or folder
structure if the changes leave the folders empty. If true, a ..gitkeep
file is created for empty folders. The default is false.
$sel:repositoryName:CreateCommit'
, createCommit_repositoryName
- The name of the repository where you create the commit.
$sel:branchName:CreateCommit'
, createCommit_branchName
- The name of the branch where you create the commit.
Request Lenses
createCommit_setFileModes :: Lens' CreateCommit (Maybe [SetFileModeEntry]) Source #
The file modes to update for files in this commit.
createCommit_email :: Lens' CreateCommit (Maybe Text) Source #
The email address of the person who created the commit.
createCommit_authorName :: Lens' CreateCommit (Maybe Text) Source #
The name of the author who created the commit. This information is used as both the author and committer for the commit.
createCommit_parentCommitId :: Lens' CreateCommit (Maybe Text) Source #
The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.
createCommit_deleteFiles :: Lens' CreateCommit (Maybe [DeleteFileEntry]) Source #
The files to delete in this commit. These files still exist in earlier commits.
createCommit_putFiles :: Lens' CreateCommit (Maybe [PutFileEntry]) Source #
The files to add or update in this commit.
createCommit_commitMessage :: Lens' CreateCommit (Maybe Text) Source #
The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.
createCommit_keepEmptyFolders :: Lens' CreateCommit (Maybe Bool) Source #
If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.
createCommit_repositoryName :: Lens' CreateCommit Text Source #
The name of the repository where you create the commit.
createCommit_branchName :: Lens' CreateCommit Text Source #
The name of the branch where you create the commit.
Destructuring the Response
data CreateCommitResponse Source #
See: newCreateCommitResponse
smart constructor.
CreateCommitResponse' | |
|
Instances
newCreateCommitResponse Source #
Create a value of CreateCommitResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commitId:CreateCommitResponse'
, createCommitResponse_commitId
- The full commit ID of the commit that contains your committed file
changes.
$sel:treeId:CreateCommitResponse'
, createCommitResponse_treeId
- The full SHA-1 pointer of the tree information for the commit that
contains the commited file changes.
$sel:filesAdded:CreateCommitResponse'
, createCommitResponse_filesAdded
- The files added as part of the committed file changes.
$sel:filesUpdated:CreateCommitResponse'
, createCommitResponse_filesUpdated
- The files updated as part of the commited file changes.
$sel:filesDeleted:CreateCommitResponse'
, createCommitResponse_filesDeleted
- The files deleted as part of the committed file changes.
$sel:httpStatus:CreateCommitResponse'
, createCommitResponse_httpStatus
- The response's http status code.
Response Lenses
createCommitResponse_commitId :: Lens' CreateCommitResponse (Maybe Text) Source #
The full commit ID of the commit that contains your committed file changes.
createCommitResponse_treeId :: Lens' CreateCommitResponse (Maybe Text) Source #
The full SHA-1 pointer of the tree information for the commit that contains the commited file changes.
createCommitResponse_filesAdded :: Lens' CreateCommitResponse (Maybe [FileMetadata]) Source #
The files added as part of the committed file changes.
createCommitResponse_filesUpdated :: Lens' CreateCommitResponse (Maybe [FileMetadata]) Source #
The files updated as part of the commited file changes.
createCommitResponse_filesDeleted :: Lens' CreateCommitResponse (Maybe [FileMetadata]) Source #
The files deleted as part of the committed file changes.
createCommitResponse_httpStatus :: Lens' CreateCommitResponse Int Source #
The response's http status code.