-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add gh actions / tooling section
- Loading branch information
1 parent
cd71c09
commit b01b53f
Showing
4 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: GitHub Actions | ||
description: How to use our GitHub Actions to automate your workflows. | ||
--- | ||
|
||
## Validate | ||
|
||
![Flipt Validate Action](/images/tooling/validate-action.png) | ||
|
||
The [flipt-validate action](https://github.com/flipt-io/validate-action) is used to validate your [features.yml](/configuration/storage#flag-state-configuration) files in a GitHub workflow. We recommend to use this action in your workflow to ensure that your Flipt data is syntactically and semantically valid before deploying when using [Git](https://www.flipt.io/docs/configuration/storage#git) or other [file-based backends](https://www.flipt.io/docs/configuration/storage#filesystem). | ||
|
||
It uses the [`flipt validate`](/cli/commands/validate) command under the hood to validate your data. If the data is invalid, the action will fail and provide a detailed error annotation at the source of the error. | ||
|
||
### Usage | ||
|
||
The following example demonstrates how to use the action in a GitHub workflow. | ||
|
||
```yaml | ||
validate: | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Checkout the target repository | ||
- uses: actions/checkout@v3 | ||
|
||
- uses: flipt-io/[email protected] | ||
# with: | ||
# Optional, the token to use for GitHub API requests | ||
# github-token: ${{ secrets.GITHUB_TOKEN }} | ||
# Optional, the directory to validate, defaults to the repository root | ||
# working-directory: | ||
``` |