Skip to content
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.

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

Improve docs #79

Merged
merged 2 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ environments to ensure cross-platform builds work correctly.
```yaml
- uses: pulumi/verify-provider-release@v1
with:
# The runtime to test against. One of `nodejs`, `python`, `dotnet`, `go` or `java`.
# The runtime to test against. One of `nodejs`, `python`, `dotnet` or `go`.
runtime: 'nodejs'
# Path to a Pulumi program to use for the test.
directory: examples/simple-nodejs
Expand All @@ -37,6 +37,21 @@ environments to ensure cross-platform builds work correctly.
goModuleTemplate: 'github.com/{publisher}/pulumi-{provider}/sdk{moduleVersionSuffix}'
```

### Language-Specific Details

#### Python

1. When testing prereleases, you'll need to set the `packageVersion` because it
will always be a different format to the provider's version.
1. The `Pulumi.yaml` runtime must set the `virtualenv` option to `venv`:

```yaml
runtime:
name: python
options:
virtualenv: venv
```

## Development Setup

1. :hammer_and_wrench: Install the dependencies
Expand Down
3 changes: 1 addition & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ branding:
inputs:
runtime:
description:
The runtime to test against. One of `nodejs`, `python`, `dotnet`, `go` or
`java`.
The runtime to test against. One of `nodejs`, `python`, `dotnet` or `go`.
required: true
directory:
description: Path to a Pulumi program to use for the test.
Expand Down
2 changes: 1 addition & 1 deletion dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import * as core from '@actions/core'
import { verifyRelease } from './verifyRelease'
import { parse } from 'semver'

const supportedRuntimes = ['python', 'nodejs', 'dotnet', 'go', 'java', 'yaml']
const supportedRuntimes = ['python', 'nodejs', 'dotnet', 'go', 'yaml']

/**
* The main function for the action.
Expand Down
Loading