Skip to content

Commit 8fa4129

Browse files
committed
chore: update README
1 parent d826109 commit 8fa4129

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ This action accepts the following inputs:
1313
- `path`: **(required)** Path of the app(s) root (support glob pattern)
1414
- `args`: Extra arguments to pass to the CLI
1515

16-
### Example
16+
### Examples
17+
18+
#### Deploy a single app
1719

1820
```yaml
1921
name: Deploy to Frontify Marketplace
@@ -43,9 +45,52 @@ jobs:
4345
- name: Deploy to Frontify Marketplace
4446
uses: samuelalev/frontify-app-deploy-action@main
4547
with:
48+
path: './path/to/block'
49+
token: ${{ secrets.FRONTIFY_TOKEN }}
4650
instanceDomain: 'app.frontify.com'
51+
```
52+
53+
#### Deploy multiple apps
54+
55+
This example uses pnpm as a monorepo tool, but you can use any other tool.
56+
57+
```yaml
58+
name: Deploy to Frontify Marketplace
59+
60+
on:
61+
push:
62+
branches:
63+
- main
64+
65+
jobs:
66+
deploy:
67+
runs-on: ubuntu-latest
68+
69+
steps:
70+
- name: Checkout
71+
uses: actions/checkout@v4
72+
73+
- name: Use pnpm
74+
uses: pnpm/action-setup@v2
75+
with:
76+
version: latest
77+
run_install: false
78+
79+
- name: Use Node.js 20
80+
uses: actions/setup-node@v4
81+
with:
82+
node-version: '20'
83+
cache: 'pnpm'
84+
85+
- name: Install dependencies
86+
run: pnpm i --frozen-lockfile
87+
88+
- name: Deploy to Frontify Marketplace
89+
uses: samuelalev/frontify-app-deploy-action@main
90+
with:
91+
path: './packages/*' # Deploy all apps in the packages folder
4792
token: ${{ secrets.FRONTIFY_TOKEN }}
48-
path: './path/to/block'
93+
instanceDomain: 'app.frontify.com'
4994
```
5095
5196
## License

0 commit comments

Comments
 (0)