Skip to content

docs: document Go source zip artifact for fern generate --pack #6480

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

Open
devin-ai-integration wants to merge 1 commit into from
+9 −1
Open

docs: document Go source zip artifact for fern generate --pack #6480

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
10 changes: 9 additions & 1 deletion fern/products/cli-api-reference/pages/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,15 @@ hideOnThisPage: true
| Ruby | gem (`.gem`) |
| PHP | Composer archive (`.zip`) |
| Rust | crate (`.crate`) |
| Go | module source archive (`.zip`), since `go get` always fetches source |
| Go | module source zip (`<output-dir>-source.zip`) |

Go modules have no binary package format, so the Go artifact is a zip of the generated module source, excluding `fern-dist/` and `.git/`. Fern builds it in-process: it produces the same artifact in either pack mode and requires no Go toolchain. Consumers unzip it and point their `go.mod` at the unzipped directory:

```go title="go.mod"
require github.com/plantstore/plantstore-go v0.0.0

replace github.com/plantstore/plantstore-go => ../plantstore-go
```

Swift SDKs are distributed as Swift Package Manager source packages, so packaging logs a warning instead of producing an artifact: share the output directory or reference it as a local package dependency. If packaging fails for one or more generators, the CLI reports them together as `Packaging failed for: <generators>` and removes any empty `fern-dist/` directory it created.

Expand Down