Skip to content

doc: document the new github_repository field in the sdk_generation.yml file #43

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
walker-tx merged 1 commit into from
Jun 5, 2025
Merged

doc: document the new github_repository field in the sdk_generation.yml file #43

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
4 changes: 3 additions & 1 deletion docs/speakeasy-reference/generation/ci-cd-pipeline.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,16 @@ jobs:
mode: pr
set_version: ${{ github.event.inputs.set_version }}
speakeasy_version: latest
github_repository: acme-org/acme-sdk-typescript
```

<Table
data={[
{ name: "speakeasy_version", description: "Version of the Speakeasy CLI to use. Use \"latest\" to always use the latest version.", type: "string", default: "latest" },
{ name: "mode", description: "Workflow mode: `direct` commits changes directly to the branch, `pr` creates a pull request, or `test` fully runs through generation without modifying any GitHub state.", type: "string", default: "direct" },
{ name: "force", description: "Forces SDK generation, even if no changes are detected.", type: "boolean", default: "false" },
{ name: "set_version", description: "Manually set a specific version for the SDK being generated.", type: "string", default: "None" }
{ name: "set_version", description: "Manually set a specific version for the SDK being generated.", type: "string", default: "None" },
{ name: "github_repository", description: "The GitHub repository path (e.g., 'owner/repo-name') that package registries should reference. This overrides the default repository detected from the current Git context.", type: "string", default: "None" }
]}
columns={[
{ key: "name", header: "Input Name" },
Expand Down
Loading