https://github.com/configu/setup-cli-action

Sets up Configu CLI in your GitHub Actions workflow
https://github.com/configu/setup-cli-action

configuration configuration-files configuration-management github github-actions

Last synced: 3 months ago
JSON representation

Sets up Configu CLI in your GitHub Actions workflow

• Host: GitHub
• URL: https://github.com/configu/setup-cli-action
• Owner: configu
• License: apache-2.0
• Created: 2022-06-29T08:22:16.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-03T02:51:48.000Z (over 1 year ago)
• Last Synced: 2024-10-01T15:13:55.460Z (4 months ago)
• Topics: configuration, configuration-files, configuration-management, github, github-actions
• Homepage: https://github.com/marketplace/actions/setup-configu-cli
• Size: 513 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# configu/setup-cli-action

[![Test setup Configu CLI GitHub Actions](https://github.com/configu/setup-cli-action/actions/workflows/setup-cli-action.yml/badge.svg)](https://github.com/configu/setup-cli-action/actions/workflows/setup-cli-action.yml)

The `configu/setup-cli-action` action is a [composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) that sets up Configu CLI in your GitHub Actions workflow by downloading a specific version of Configu CLI and adding it to the `PATH`.

After you've used the action, subsequent steps in the same job can run arbitrary Configu CLI commands. All of Configu commands work exactly like they do on your local command line.

## Usage

This action can be run on `ubuntu-*` and `macos-*` GitHub Actions runners. 

The default configuration installs the latest version of Configu CLI.

```yaml

steps:

  - uses: configu/setup-cli-action@v1

```

A specific version of Configu CLI can be installed.

```yaml

steps:

  - uses: configu/setup-cli-action@v1

    with:

      version: 0.4.4

```

Credentials for [`Configu Platform`](https://app.configu.com/) can be configured.

```yaml

jobs:

  some-job:

    runs-on: ubuntu-latest

    env:

      CONFIGU_ORG: ${{ secrets.CONFIGU_ORG }}

      CONFIGU_TOKEN: ${{ secrets.CONFIGU_TOKEN }}

    steps:

      - name: Setup Configu CLI

        uses: configu/setup-cli-action@v1

      - name: Export configurations

        run: | 

          configu eval --store 'configu' --set 'production' --schema 'path/to/schema.cfgu.json' | configu export

```

## Inputs

The action supports the [following inputs](https://github.com/configu/setup-cli-action/blob/main/action.yml#L7).

## License

This Action is licensed under [Apache License 2.0](https://github.com/configu/setup-cli-action/blob/main/LICENSE).

## References

- [Configu SaaS Platform (app.configu.com)](https://app.configu.com/)

- [Configu Documentation](https://configu.com/docs)

- [GitHub Actions Documentation](https://help.github.com/en/categories/automating-your-workflow-with-github-actions)