Skip to content

Document Deploy Key Limitations

Problem to solve

Pushes to protected branches using deploy keys are not successful if the associated user does not have permission. This is an intended limitation, but is not clear that it is a limitation in our documentation. This leads to frustration such as #329742 (closed).

Proposal

We should make sure this behavior of deploy keys is clearly documented. We should also recommend users on what to do such as setting up a bot user when the user has a setup where long-lived deploy-keys need to outlast specific users.

Who can address the issue

@kbychu will draft and ask for help/review from @axil and @shinya.maeda

Other links/references

Edited by Kevin Chu