docs update to avoid shallow update not allowed

When I followed the instructions, I received the following error:

```
> Pushing pull request branch to 'origin/bundle-update-1667232038'
  /usr/bin/git push --force-with-lease origin HEAD:refs/heads/bundle-update-1667232038
  To github.com:****/****.git
   ! [remote rejected] HEAD -> bundle-update-1667232038 (shallow update not allowed)
  error: failed to push some refs to 'github.com:****/****.git'
```

this setting `fetch-depth: 0` in the checkout action resolved the issue.
This commit is contained in:
Michael Glass 2022-10-31 17:16:24 +01:00 committed by GitHub
parent 6c704eb7a8
commit 0697b14b11
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -196,12 +196,13 @@ How to use SSH (deploy keys) with create-pull-request action:
1. [Create a new SSH key pair](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key) for your repository. Do not set a passphrase.
2. Copy the contents of the public key (.pub file) to a new repository [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) and check the box to "Allow write access."
3. Add a secret to the repository containing the entire contents of the private key.
4. As shown in the example below, configure `actions/checkout` to use the deploy key you have created.
4. As shown in the example below, configure `actions/checkout` to use the deploy key you have created. Additionally, set fetch-depth because git won't accept a new branch from a shallow clone.
```yml
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
# Make changes to pull request here