Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flipt-io/setup-action
Install Flipt CLI in your GitHub Workflows
https://github.com/flipt-io/setup-action
cd ci continuous-deployment continuous-integration feature-flags
Last synced: about 2 months ago
JSON representation
Install Flipt CLI in your GitHub Workflows
- Host: GitHub
- URL: https://github.com/flipt-io/setup-action
- Owner: flipt-io
- License: apache-2.0
- Created: 2024-01-02T20:58:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T10:48:05.000Z (2 months ago)
- Last Synced: 2024-10-29T12:42:40.188Z (2 months ago)
- Topics: cd, ci, continuous-deployment, continuous-integration, feature-flags
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/flipt-setup-action
- Size: 2.68 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Flipt Setup Action
This action installs [Flipt](https://flipt.io) in your GitHub Actions workflow.
You can pass additional arguments to the `flipt` command using the `args` input. If no arguments are provided, `flipt` will be installed and run with the `--help` flag.
Any of the [Flipt CLI commands](https://www.flipt.io/docs/cli/overview) can be run using this action.
## Examples
### Validate
Docs:
This example installs Flipt and runs `flipt validate` against the repository root.
```yaml
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: flipt-io/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required to download flipt cli without rate limiting
# Optional, additional arguments to pass to the `flipt` command
# args:
# Optional, the version of Flipt to install, defaults to the latest release
# version:
# Optional, the directory to run Flipt against, defaults to the repository root
# working-directory:
- run: flipt validate
```
### OCI Bundle and Push
Docs:
This example installs Flipt and runs `flipt bundle build` against the repository root. It then pushes the bundle to a registry with `flipt bundle push`, allowing you to store and share your feature flag data as an OCI artifact.
```yaml
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: flipt-io/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required to download flipt cli without rate limiting
# Optional, additional arguments to pass to the `flipt` command
# args:
# Optional, the version of Flipt to install, defaults to the latest release
# version:
# Optional, the directory to run Flipt against, defaults to the repository root
# working-directory:
- name: Get UUID
id: uuid
run: |
echo "uuid=$(uuidgen)" >> $GITHUB_OUTPUT
# Build the bundle and push it to an ephemeral registry (available for 1 hour)
- name: Build and Push bundle
run: |
flipt bundle build {{ steps.uuid.outputs.uuid }}:latest ttl.sh/${{ steps.uuid.outputs.uuid }}:1h
flipt bundle push ttl.sh/${{ steps.uuid.outputs.uuid }}:1h
```
## Customizing
### inputs
Following inputs can be used as `step.with` keys
| Name | Type | Description |
| ------------------- | ------ | -------------------------------------------------------------------------- |
| `working-directory` | string | **Optional**. The directory to validate, defaults to the repository root |
| `version` | string | **Optional**. The version of Flipt to install, defaults to the latest release. |
| `args` | string | **Optional**. Additional arguments to pass to the `flipt` command |
| `GITHUB_TOKEN` | string | **Required**. The GitHub token to use to download Flipt CLI without rate limiting. |
## Development
```console
# Builds the typescript code.
npm run build
# Runs eslint.
npm run lint
# Runs prettier.
npm run format
# Packages the code into the dist folder. Must be updated to pass CI on `main`.
npm run package
# Runs all of the above commands.
npm run all
```
## License
[Apache 2.0](LICENSE)