Skip to content

Commit eeba48e

Browse files
committed
feat: add setup action for v2
Signed-off-by: Mark Phelps <[email protected]>
1 parent e1b8050 commit eeba48e

File tree

5 files changed

+55
-25
lines changed

5 files changed

+55
-25
lines changed

docs.json

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,19 @@
414414
"v2/configuration/licensing"
415415
]
416416
},
417+
{
418+
"group": "Integration",
419+
"icon": "plug",
420+
"pages": [
421+
"v2/integration/overview",
422+
{
423+
"group": "Server-Side SDKs",
424+
"pages": ["v2/integration/server/rest"]
425+
},
426+
"v2/integration/client",
427+
"v2/integration/openfeature"
428+
]
429+
},
417430
{
418431
"group": "CLI",
419432
"icon": "terminal",
@@ -487,17 +500,10 @@
487500
]
488501
},
489502
{
490-
"group": "Integration",
491-
"icon": "plug",
492-
"pages": [
493-
"v2/integration/overview",
494-
{
495-
"group": "Server-Side SDKs",
496-
"pages": ["v2/integration/server/rest"]
497-
},
498-
"v2/integration/client",
499-
"v2/integration/openfeature"
500-
]
503+
"group": "Tooling",
504+
"icon": "hammer",
505+
"tag": "NEW",
506+
"pages": ["v2/tooling/github-actions"]
501507
}
502508
]
503509
},

images/tooling/setup-action.png

610 KB
Loading

tooling/github-actions.mdx

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,27 @@ description: How to use our GitHub Actions to automate your workflows.
55

66
## Setup Flipt
77

8-
![Flipt Setup Action](/images/tooling/setup-action.png)
8+
![Flipt Setup Action](/v2/images/tooling/setup-action.png)
99

10-
The [flipt-setup-action](https://github.com/marketplace/actions/flipt-setup-action) can be used to setup Flipt in your GitHub workflow. Once setup, you can then use any of the [CLI commands](https://www.flipt.io/docs/cli/overview) that Flipt provides in your workflow.
10+
The [flipt-setup-action](https://github.com/marketplace/actions/flipt-setup-action) can be used to setup Flipt v1 in your GitHub workflow. Once setup, you can then use any of the [CLI commands](/cli/overview) that Flipt provides in your workflow.
1111

1212
### Usage
1313

14-
The following example demonstrates how to use the action in a GitHub workflow which runs the [flipt validate](https://www.flipt.io/docs/cli/commands/validate) command.
14+
The following example demonstrates how to use the action in a GitHub workflow which runs the [flipt validate](/cli/commands/validate) command.
1515

1616
```yaml
1717
validate:
1818
runs-on: ubuntu-latest
1919
steps:
20-
- uses: actions/checkout@v3
20+
- uses: actions/checkout@v4
2121

22-
- uses: flipt-io/[email protected]
23-
# with:
22+
- uses: flipt-io/[email protected]
23+
with:
24+
version: v1 # Installs the latest v2 release
2425
# Optional, additional arguments to pass to the `flipt` command
2526
# args:
26-
# Optional, the version of Flipt to install, defaults to the latest release
27-
# version:
2827
# Optional, the directory to run Flipt against, defaults to the repository root
2928
# working-directory:
3029

3130
- run: flipt validate
3231
```
33-
34-
Other commands that may be useful to run in your workflows include:
35-
36-
- [flipt bundle](/cli/commands/bundle)
37-
- [flipt export](/cli/commands/export)
38-
- [flipt import](/cli/commands/import)

v2/images/tooling/setup-action.png

697 KB
Loading

v2/tooling/github-actions.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: GitHub Actions
3+
description: How to use our GitHub Actions to automate your workflows.
4+
---
5+
6+
## Setup Flipt
7+
8+
![Flipt Setup Action](/v2/images/tooling/setup-action.png)
9+
10+
The [flipt-setup-action](https://github.com/marketplace/actions/flipt-setup-action) can be used to setup Flipt v2 in your GitHub workflow. Once setup, you can then use any of the [CLI commands](/v2/cli/overview) that Flipt provides in your workflow.
11+
12+
### Usage
13+
14+
The following example demonstrates how to use the action in a GitHub workflow which runs the [flipt validate](/v2/cli/commands/validate) command.
15+
16+
```yaml
17+
validate:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- uses: flipt-io/[email protected]
23+
with:
24+
version: v2 # Installs the latest v2 release
25+
# Optional, additional arguments to pass to the `flipt` command
26+
# args:
27+
# Optional, the directory to run Flipt against, defaults to the repository root
28+
# working-directory:
29+
30+
- run: flipt validate
31+
```

0 commit comments

Comments
 (0)