Skip to content

Commit e526a53

Browse files
authored
Merge pull request #8 from rogerchappel/agent/stackforge-github-creation-flow-add-explicit-dry-run-first-gh-cli-integr
docs: document GitHub repo creation flow
2 parents c13dc34 + 3f72f27 commit e526a53

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/github-repository-creation.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# GitHub repository creation
2+
3+
StackForge does not create GitHub repositories by default. The `init` command only plans GitHub repository creation when `--github-create` is present.
4+
5+
## Dry-run-first flow
6+
7+
Run with `--github-create` to print the planned `gh repo create` command in the JSON output without executing it:
8+
9+
```bash
10+
pnpm dev init oss-cli my-tool --github-create
11+
```
12+
13+
The default GitHub repository visibility is `private`. Use `--github-visibility public` only when you intentionally want a public repository:
14+
15+
```bash
16+
pnpm dev init oss-cli my-tool --github-create --github-visibility public
17+
```
18+
19+
After reviewing the printed `github.command`, rerun with `--github-execute` to create the repository through the GitHub CLI:
20+
21+
```bash
22+
pnpm dev init oss-cli my-tool --github-create --github-execute
23+
```
24+
25+
## Safety rules
26+
27+
- Without `--github-create`, StackForge reports `github.mode` as `noop` and never calls `gh`.
28+
- `--github-create` defaults to `github.mode: "dry-run"` for the GitHub command.
29+
- `--github-execute` requires `--github-create` so repository creation is always explicit.
30+
- `--github-execute` cannot be combined with `--dry-run`.
31+
- GitHub creation uses the installed `gh` CLI and any authentication already configured for it.

0 commit comments

Comments
 (0)