https://github.com/planetscale/setup-pscale-action

Setup the PlanetScale CLI for GitHub Actions
https://github.com/planetscale/setup-pscale-action

actions cli planetscale

Last synced: about 1 month ago
JSON representation

Setup the PlanetScale CLI for GitHub Actions

• Host: GitHub
• URL: https://github.com/planetscale/setup-pscale-action
• Owner: planetscale
• License: apache-2.0
• Created: 2023-06-17T12:15:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-01T16:31:00.000Z (8 months ago)
• Last Synced: 2024-05-02T11:18:56.183Z (8 months ago)
• Topics: actions, cli, planetscale
• Language: TypeScript
• Homepage: https://planetscale.com/docs/devops/github-actions
• Size: 667 KB
• Stars: 19
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PlanetScale CLI for GitHub Actions

Use this Action to install `pscale` on your actions runner. Works with Linux, Mac and Windows runners.

```yaml

- name: Setup pscale

  uses: planetscale/setup-pscale-action@v1

- name: Use pscale

  env:

    PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}

    PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}

  run: |

    pscale deploy-request list my-db --org my-org

```

Be sure to [setup a service token](https://planetscale.com/docs/concepts/service-tokens) with the proper permissions and add it to your repositories secrets.

**Example with version pinned:**

Setting the `version` is optional. When omitted, the action will download the latest version. [See full list of releases](https://github.com/planetscale/cli/releases).

```yaml

- name: Setup pscale

  uses: planetscale/setup-pscale-action@v1

  with:

    version: v0.183.0

```

## Examples

See our [PlanetScale + GitHub Actions doc](https://planetscale.com/docs/devops/github-actions) for ideas on how to use `pscale` in your Actions Workflows.

## Development

Install the dependencies  

```bash

$ npm install

```

Build the typescript and package it for distribution

```bash

$ npm run build && npm run package

```

## License

The action is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/license/apache-2-0/).