docs(cloud): Guide for private git dependencies#590
Conversation
Swiftaxe
left a comment
Swiftaxe
left a comment
There was a problem hiding this comment.
Nice update!
Added a few nit comments.
|
|
||
| [Set up deploy keys in GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys#set-up-deploy-keys) | ||
|
|
||
| Then store the private SSH key as a build secret on your Severpod Cloud project, |
There was a problem hiding this comment.
| Then store the private SSH key as a build secret on your Severpod Cloud project, | |
| Then store the private SSH key as a build secret on your Serverpod Cloud project, |
|
|
||
| Use the `scloud deployment build-secret` commands to manage your build secrets. | ||
|
|
||
| #### List the current build secrets |
There was a problem hiding this comment.
This skips from H2 headings to H4. Consider whether to add an H3 heading above the H4 ones, or bump them to H3.
|
|
||
| Do this by setting a _build secret_ on the project. | ||
|
|
||
| > Build secrets are kept separate from runtime secrets and will not be accessible |
There was a problem hiding this comment.
Use a docusaurus :::info admonition here instead of a blockquote.
|
|
||
| ### SSH keys | ||
|
|
||
| Currently SSH keys are supported, and you store the private SSH key in the build secret. |
There was a problem hiding this comment.
Nit: This section is too thin. Consider whether this line belongs in the section above together with the ssh file example.
Also, "Currently" suggests something is about to change. It is better to be specific about whether we are moving away from it.
There was a problem hiding this comment.
Suggestion (line 3, intro): the current opening frames workspaces as the only path, but the PR adds private-git-deps as a second path. Surfacing both up front helps the reader pick.
Proposed rewrite of line 3:
Serverpod Cloud handles private dependencies in two ways: as local packages in a Dart workspace, or as private git dependencies authenticated with an SSH-key build secret. Pick the one that matches how your private code is stored.
3 participants
No description provided.