Set the Package Owner field to the user or organization that will “own” the SDK artifact.
Ensure the API key has the relevant Push scope. If the package already exists, the API key may not need “Push new packages and package versions” permissions.
Populate the Glob Pattern and Available Packages fields in a way that allows publishing the SDK. Use the packageName specified in the gen.yaml file.
Store the NUGET_API_KEY in the GitHub Actions secrets.
In the C# section of gen.yaml add:
In the info section of the OpenAPI document, describe what the package is for in the description property. It will be set as the Package description , visible when searching for the package on NuGet.
In the externalDocs section of the OpenAPI document, provide the website’s homepage in the url property. It will be set as the Project URL , visible in the package’s “About” section.
In the root of the repository:
Add a LICENSE[.md|.txt] file (see Licensing for more details).
Add a 128x128 dimension image file called icon[.jpg|.png]to display on the NuGet package page.
Review the NUGET.md file, which is similar to the main README.md but excludes the SDK Installation and Available Operations sections. For more details, see Editing SDK Docs.
PHP
Create a Packagist account and manually create the Packagist package.
Cleaner build process without workspace dependencies
Easier configuration of linting and other tools
Simplified version control and release management
Direct GitHub issues integration for better user support
Independent versioning and release cycles
Publishing in the Speakeasy dashboard
The SDK publishing tab in the Speakeasy dashboard provides an overview of the publishing history and offers various utilities for setting up and maintaining SDK publishing.
app.speakeasy.com
If package manager secrets were not set during the initial SDK repo setup, the publishing dashboard provides an interface to attach these secrets to the repository.
app.speakeasy.com
For GitHub actions set up with mode:pr, the publishing dashboard highlights open PRs in the SDK repo that are pending release. This view displays the exact SDK version that will be published upon merging the PR.