connected-web/Publish NPM Package from OpenAPI Spec
Use an OpenAPI spec to generate and publish an npm package to the GitHub Package Registry
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token used to publish the package to the registry | — | — |
| client-id | OAuth client ID used to fetch the OpenAPI spec from a URL | — | — |
| client-secret | OAuth client secret used to fetch the OpenAPI spec from a URL | — | — |
| oauth-token-endpoint | OAuth token endpoint used to fetch an access token for fetching the OpenAPI spec from a URL | — | — |
| package-id | ID of the package to publish - should explicitly include @connected-web/ prefix otherwise the action will exit early | — | — |
| openapi-spec-file | Path to the OpenAPI spec file to use for generating the package | — | — |
| openapi-spec-url | URL to the OpenAPI spec file to use for generating the package - uses an OAuth token based on client-id and client-secret to fetch the spec | — | — |
| version | Version of the package to publish - should be a valid semver version. For branches other than main, this should be a pre-release version | — | — |
| preview-mode | Whether to hold off on publishing the package to the registry. If true, the package will be built and tested but not published to the registry | — | false |
| source-repo-id | The repository to use as the source for the action - used to search and replace values in the template | — | connected-web/pnpfos |
Outputs
| name | description |
|---|---|
| package-id | String containing the ID of the package that was published |
| published-version | String containing the actual version of the package that was published (after invalid semver characters were removed) |