Skip to content

Document workspace manifest source formats #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeforester merged 1 commit into from
Jun 22, 2026
+28 −0
Merged

Document workspace manifest source formats #999

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/workspace-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,34 @@ default. Remote source fetching is therefore an explicit manifest-file update,
not passive workspace discovery, and it does not clone, pull, reset, or rewrite
project repositories.

### Accepted Source Formats

`workspace.manifest_source` accepts these source shapes:

```yaml
workspace:
manifest_source: file:///Users/alex/work/platform/workspace.yaml
```

```yaml
workspace:
manifest_source: https://raw.githubusercontent.com/example/platform/main/workspace.yaml
```

```yaml
workspace:
manifest_source: ~/work/platform/workspace.yaml
```

```yaml
workspace:
manifest_source: /opt/base/workspaces/platform.yaml
```

Use Git SSH clone URLs such as `git@github.com:example/service.git` only in
workspace manifest `repos[].url` entries. They identify repositories to clone;
they are not workspace manifest source URLs.

## Trust And Authentication

Base should delegate repository authentication to Git, SSH, and the GitHub CLI.
Expand Down
Loading