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.
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.
| - **Private git references**: Dependencies pointing to private Git repositories using `git:` URLs are not supported during deployment. | ||
| - **Private package managers**: Custom package registry configurations are not supported. | ||
|
|
||
| If you need to include private code in your deployment, use Dart workspaces to manage these dependencies as local packages within your project structure. |
There was a problem hiding this comment.
Nit: with workspaces and private git deps now both documented above, this closer is redundant. Consider cutting it. Current limitations then reads as a clean "what's not supported" list without the appended workspace recap.
| ``` | ||
|
|
||
| #### Add or modify a build secret with the value in a file | ||
| ``` |
There was a problem hiding this comment.
Nit: this code block is missing the language tag the other two use. Add sh (or bash) so syntax highlighting matches.
| #### Add or modify a build secret with the value in a file | ||
| ``` | ||
| $ scloud deployment build-secret set MY_SECRET_NAME --from-file my_private_ssh_key_file | ||
| ``` |
There was a problem hiding this comment.
Just mentioning: worth adding a way to unset/remove a build secret here, because rotating an SSH key or revoking access is a common follow-up. Without it documented, readers will either leave stale secrets behind or guess.
developerjamiu
added
documentation
3 participants
No description provided.