added optional allow empty commits (#7186)

* added optional allow empty commits
treeverse · Jan 3, 2024 · 88247ac · 88247ac
1 parent fd2a2d5
commit 88247ac
Show file tree

Hide file tree

Showing 29 changed files with 173 additions and 60 deletions.
diff --git a/api/swagger.yml b/api/swagger.yml
@@ -580,6 +580,10 @@ components:
           description: set date to override creation date in the commit (Unix Epoch in seconds)
           type: integer
           format: int64
+        allow_empty:
+          description: sets whether a commit can contain no changes
+          type: boolean
+          default: false
         force:
           type: boolean
           default: false

diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml
diff --git a/clients/java-legacy/docs/CommitCreation.md b/clients/java-legacy/docs/CommitCreation.md
diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/CommitCreation.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/CommitCreation.java
diff --git a/clients/java-legacy/src/test/java/io/lakefs/clients/api/model/CommitCreationTest.java b/clients/java-legacy/src/test/java/io/lakefs/clients/api/model/CommitCreationTest.java
diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml
diff --git a/clients/java/docs/CommitCreation.md b/clients/java/docs/CommitCreation.md
diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/CommitCreation.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/CommitCreation.java
diff --git a/clients/java/src/test/java/io/lakefs/clients/sdk/model/CommitCreationTest.java b/clients/java/src/test/java/io/lakefs/clients/sdk/model/CommitCreationTest.java
diff --git a/clients/python-legacy/docs/CommitCreation.md b/clients/python-legacy/docs/CommitCreation.md
diff --git a/clients/python-legacy/docs/CommitsApi.md b/clients/python-legacy/docs/CommitsApi.md
diff --git a/clients/python-legacy/docs/ImportApi.md b/clients/python-legacy/docs/ImportApi.md
diff --git a/clients/python-legacy/lakefs_client/model/commit_creation.py b/clients/python-legacy/lakefs_client/model/commit_creation.py
diff --git a/clients/python/docs/CommitCreation.md b/clients/python/docs/CommitCreation.md
diff --git a/clients/python/lakefs_sdk/models/commit_creation.py b/clients/python/lakefs_sdk/models/commit_creation.py
diff --git a/clients/python/test/test_commit_creation.py b/clients/python/test/test_commit_creation.py
diff --git a/clients/python/test/test_import_creation.py b/clients/python/test/test_import_creation.py
diff --git a/cmd/lakectl/cmd/commit.go b/cmd/lakectl/cmd/commit.go
@@ -14,6 +14,7 @@ var errInvalidKeyValueFormat = errors.New(`invalid key/value pair - should be se
 
 const (
 	dateFlagName         = "epoch-time-seconds"
+	allowEmptyCommit     = "allow-empty-commit"
 	commitCreateTemplate = `Commit for branch "{{.Branch.Ref}}" completed.
 
 ID: {{.Commit.Id|yellow}}
@@ -32,6 +33,7 @@ var commitCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		message, kvPairs := getCommitFlags(cmd)
 		date := Must(cmd.Flags().GetInt64(dateFlagName))
+		emptyCommitBool := Must(cmd.Flags().GetBool(allowEmptyCommit))
 		datePtr := &date
 		if date < 0 {
 			datePtr = nil
@@ -46,9 +48,10 @@ var commitCmd = &cobra.Command{
 		}
 		client := getClient()
 		resp, err := client.CommitWithResponse(cmd.Context(), branchURI.Repository, branchURI.Ref, &apigen.CommitParams{}, apigen.CommitJSONRequestBody{
-			Message:  message,
-			Metadata: &metadata,
-			Date:     datePtr,
+			Message:    message,
+			Metadata:   &metadata,
+			Date:       datePtr,
+			AllowEmpty: &emptyCommitBool,
 		})
 		DieOnErrorOrUnexpectedStatusCode(resp, err, http.StatusCreated)
 		if resp.JSON201 == nil {
@@ -66,6 +69,7 @@ var commitCmd = &cobra.Command{
 //nolint:gochecknoinits
 func init() {
 	commitCmd.Flags().Int64(dateFlagName, -1, "create commit with a custom unix epoch date in seconds")
+	commitCmd.Flags().Bool(allowEmptyCommit, false, "allow a commit with no changes")
 	if err := commitCmd.Flags().MarkHidden(dateFlagName); err != nil {
 		DieErr(err)
 	}

diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml
@@ -580,6 +580,10 @@ components:
           description: set date to override creation date in the commit (Unix Epoch in seconds)
           type: integer
           format: int64
+        allow_empty:
+          description: sets whether a commit can contain no changes
+          type: boolean
+          default: false
         force:
           type: boolean
           default: false

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -1893,6 +1893,7 @@ lakectl commit <branch URI> [flags]
 {:.no_toc}
 
 ```
+      --allow-empty-commit    allow a commit with no changes
       --allow-empty-message   allow an empty commit message
   -h, --help                  help for commit
   -m, --message string        commit message