Skip to content

docs: add secret management documentation for SDK generation #2911

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
base: main
Choose a base branch
from
Open

docs: add secret management documentation for SDK generation #2911

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: 10 additions & 0 deletions fern/products/sdks/project-structure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,13 @@ See [Project structure (API Definitions)](/api-definitions/overview/project-stru
1. **Create repositories**: Set up your source repository, plus one repository for each SDK
2. **Install Fern GitHub App**: Install the [Fern GitHub App](https://github.com/apps/fern-api) on all repositories
3. **Configure `generators.yml`**: In your `generators.yml`, add a reference to each SDK repository.

## Secret management

The Fern GitHub App automatically syncs secrets from your source repository to your SDK repositories during each generation run. This ensures your SDK repositories always have up-to-date credentials for publishing to package registries like npm, PyPI, and Maven Central.

Configure secrets only in your source repository (where `generators.yml` lives). The Fern GitHub App copies these secrets to each SDK repository's GitHub Actions secrets, so you don't need to manually configure secrets in multiple places. If you update a credential in your source repository, the next generation run automatically propagates the change to all SDK repositories.

<Note>
If you notice secrets updated in your SDK repository that you didn't change directly, this is the Fern GitHub App syncing credentials from your source repository.
</Note>