Setup Neon CLI

Setup Neon is a GitHub action that provides a cross-platform interface for setting up the Neon CLI in GitHub Actions runners.

Inputs

The following inputs are supported.

- name: Setup Neon
  uses: nhedger/setup-neon@v1
  with:

    # The version of the Neon CLI to install.
    # This input is optional and defaults to "latest".
    # Example values: "1.36.0", "latest"
    version: "latest"

    # The GitHub token to use to authenticate GitHub API requests.
    # This input is optional and defaults to the job's GitHub token.
    # Example value: ${{ secrets.GITHUB_TOKEN }}
    token: ${{ github.token }}

Examples

Basic example

Setup the latest version of the Neon CLI.

- name: Setup Neon
  uses: nhedger/setup-neon@v1

- name: List branches
  run: neonctl branches list
  env:
    NEON_API_KEY: ${{ secrets.NEON_API_KEY }}

Specific version

Install version 1.36.0 of the Neon CLI.

- name: Setup Neon CLI
  uses: nhedger/setup-neon@v1
  with:
    version: 1.36.0

- name: List branches
  run: neonctl branches list
  env:
    NEON_API_KEY: ${{ secrets.NEON_API_KEY }}

License

This project is licensed under the MIT License.

Copyright (c) 2024 Nicolas Hedger

Disclaimer: The "Neon" logo is a trademark of its respective owner and is not covered by this project's license. It is used here for illustrative purposes only.