Skip to content
anchor

GitHub Action

Pulumi Helm Updater

v1.1.0 Latest version

Pulumi Helm Updater

anchor

Pulumi Helm Updater

Determine if a update to a pulumi managed helm chart is available

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Pulumi Helm Updater

              
  uses: LambArchie/[email protected]
Learn more about this action in LambArchie/pulumi-helm-updater

Choose a version

Pulumi Helm Updater

This is a GitHub Action/Node Script which reads your pulumi stack state and checks if any of the charts in that stack can be updated.

Currently this only supports helm.v3.Release and not helm.v3.Chart as I couldn't find a nice way to get the current chart version.

Usage

- uses: LambArchie/pulumi-helm-updater@v1
  with:
    # Which pulumi stack to check for helm release updates
    # Set to your pulumi stack name
    stack_name: services

    # Set to the folder which contains your target 'Pulumi.yaml'
    # Defaults to repo root
    stack_location: pulumi/

    # Set to the file location of an already exported pulumi stack
    # To export run 'pulumi stack export'
    # If set do not set either stack_name or stack_location
    # as they will not be used
    # Recommend doing this way if your stack requires configuration before accessing
    stack_file: export.json

    # What format the input stack file is
    # Only utilised if stack_file is set
    #   'export'  - If used 'pulumi stack export'
    #   'preview' - If used 'pulumi preview --show-sames --json'
    stack_file_type: export

    # What if any output to disk should occur
    #   'none' - Disable writing to disk (default)
    #   'js'   - Output in a format JavaScript can understand
    #            Format is 'export const releaseVersion = '1.2.3'
    #            Example can be seen in example/helmVersions.ts
    # Custom formats can be done via the action output
    # Default: none
    write_format: js

    # What location should be written to if write_format
    # is not set to 'none'
    # Path is relative to repo root
    write_location: helmVersions.ts

Outputs

This action outputs latest_versions which is a JSON object in the following format.

[
  {
    "chart": "chart-name",
    "currentVersion": "1.2.3",
    "error": false,
    "latestVersion": "2.0.0"
  }
]

If error is true latestVersion will ALWAYS equal currentVersion as this action failed to determine the latest release for that chart.
Reason latestVersion isn't missing is because I felt it was better for latestVersion to always be present than sometimes missing.

Examples

Use stack name

- uses: LambArchie/pulumi-helm-updater@v1
  with:
    # Set to your pulumi stack name
    stack_name: services

Use stack file

- uses: LambArchie/pulumi-helm-updater@v1
  with:
    # Set to the file contain the output of 'pulumi stack export'
    stack_file: export.json

    stack_file_type: export

Use preview output

- uses: LambArchie/pulumi-helm-updater@v1
  with:
    # Set to the file contain the output of 'pulumi preview --show-sames --json'
    stack_file: preview.json
    stack_file_type: preview

Advanced Output

- uses: LambArchie/pulumi-helm-updater@v1
  id: helm-updates
  with:
    stack_name: services

    # Leaving at default as using action output instead
    write_format: none

- run: echo "${{ steps.helm-updates.outputs.latest_versions }} > out.txt"