actions-marketplace-validations/Preview Pull Requests in Kubernetes
Deploy preview of Pull Requests to Kubernetes using Helm charts
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Oct 24, 2024
- License
- MIT
- Runtime
- Deprecated runtime
Pinned Snippet
uses: actions-marketplace-validations/vendanor_preview-pull-request@2f7b5cb04a1bba6220dc74e957427e4c23b03269 # no releases — HEAD as of 2026-07-10tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| token | Your Github token | yes | $ |
| probe | Set to true if you only want to probe for information | no | false |
| docker-file | Dockerfile to build, tag with preview metadata and publish to container registry | no | Dockerfile |
| docker-registry | Docker container registry. Defaults to Github container registry | no | ghcr.io |
| docker-username | Username docker container registry, ghcr? github.repository_owner | no | — |
| docker-password | Password docker container registry | no | — |
| docker-image-name | Example vn-my-app | no | — |
| docker-organization | Organization used to construct docker registry url | no | vendanor |
| docker-tag-major | Major tag used when tagging docker images, example: 1.0 | no | 1.0 |
| docker-pullsecret | Docker pullsecret to use when pulling docker images from registry when deploying helm chart | no | — |
| helm-namespace | Helm namespace where Helm releases are published. Also used as k8s namespace! | no | preview |
| helm-repo-url | Helm chart repo. If supplied, Helm charts are published here | no | https://helm.vendanor.com |
| helm-organization | Used when pushing helm chart to helm chart repo | no | vendanor |
| helm-repo-user | Username to helm chart repo if you want to publish chart | no | vendanor |
| helm-repo-password | Helm chart repo password if you want tp publish chart | no | — |
| helm-chart | Path to helm chart in repo, example: charts/vn-my-app | no | chart |
| helm-tag-major | Major tag when tagging helm chart previews, example: 1.0 | yes | 1.0 |
| helm-remove-preview-charts | Remove all preview helm charts when calling command remove | yes | true |
| helm-key-appname | The key to set in your helm chart to set when installing preview | yes | appname |
| helm-key-namespace | k8s namespace key to override | yes | namespace |
| helm-key-image | The key to set in your helm chart to set when installing preview | yes | image |
| helm-key-pullsecret | The key to set in your helm chart to set when installing preview | yes | pullsecret |
| helm-key-host | The key to set in your helm chart to set when installing preview | yes | host |
| helm-key-containersuffix | The key to set in your helm chart to set when installing preview | yes | containersuffix |
| helm-key-cluster-issuer | The key to set in your helm chart to set when installing preview | yes | clusterIssuer |
| helm-key-tls-secret-name | The key to set in your helm chart to set when installing preview | yes | tlsSecretName |
| app-name | App name used in preview url. | yes | — |
| hash-salt | Secret salt used to generate preview hash | no | salt |
| base-url | Base preview url, example preview.domain.com | no | pr.st.vendanor.com |
| cluster-issuer | Name of cluster issuer to use | yes | vn-letsencrypt-preview-issuer |
| tls-secret-name | Certificate secret name. Use a shared name for wildcard certs | yes | vn-preview-wild |
| helm-values | Extra values to pass to helm upgrade --set. Example: key1=val1,key2=val2 | no | — |
| wait | Waits until deployment is successful, pods are running, etc. before marking the release as successful | no | false |
Outputs
| name | description |
|---|---|
| previewUrl | Complete url to preview |
| dockerImageVersion | Docker image name including tags (semver) |
| helmReleaseName | Helm chart release version including tags (semver) |
| success | was everything successful or not. |
| isPreviewEnabled | Returns true if user has requested a preview. Checks hidden value in comment |
| isBot | Returns true if action was triggered by a bot |
| isComment | Returns true if action was triggered by a comment |
| isValidCommand | Returns true if comment contains a valid command |
| isAddPreviewPending | Returns true if a preview will be deployed |
| isRemovePreviewPending | Returns true if a preview will be removed |
| pullRequestNumber | Returns the pull request number |
| headRef | Use this to checkout the correct ref when triggered by a comment. Can be null |