From 36e02c74fded75511065d7567a9acea520f956b4 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Sat, 20 Feb 2021 17:43:47 -0500 Subject: [PATCH] docs: add warning regarding shallow clone pushes Closes #4405 [ci skip] --- docs/deployment/methods/git.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/deployment/methods/git.md b/docs/deployment/methods/git.md index 061c3c926..6aa534b3a 100644 --- a/docs/deployment/methods/git.md +++ b/docs/deployment/methods/git.md @@ -4,7 +4,7 @@ ``` git:allow-host # Adds a host to known_hosts -git:sync [--build] [] # Clone or fetch an app from remote git repo +git:sync [--build] [] # Clone or fetch an app from remote git repo git:initialize # Initialize a git repository for an app git:public-key # Outputs the dokku public deploy key git:report [] [] # Displays a git report for one or more apps @@ -19,6 +19,8 @@ Git-based deployment has been the traditional method of deploying applications i ## Usage +> Warning: Pushing from a shallow clone is not currently supported and may have undefined behavior. Please unshallow your local repository before pushing to a Dokku app to avoid potential errors in the deployment process. + ### Initializing an application When an application is created via `git push`, Dokku will create the proper `pre-receive` hook in order to execute the build pipeline. In certain cases - such as when fronting deploys with the [`git-http-backend`](https://git-scm.com/docs/git-http-backend) - this may not be correctly created. As an alternative, the `git:initialize` command can be used to trigger this creation: