Skip to content

Commit a16b61f

Browse files
peaceirispeaceiris
committed
docs: bump to v4 from v3
1 parent fa8661b commit a16b61f

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

‎README.md‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The next example step will deploy `./public` directory to the remote `gh-pages`
3030

3131
```yaml
3232
- name: Deploy
33-
uses: peaceiris/actions-gh-pages@v3
33+
uses: peaceiris/actions-gh-pages@v4
3434
with:
3535
github_token: ${{ secrets.GITHUB_TOKEN }}
3636
publish_dir: ./public
@@ -171,7 +171,7 @@ jobs:
171171
run: hugo --minify
172172
173173
- name: Deploy
174-
uses: peaceiris/actions-gh-pages@v3
174+
uses: peaceiris/actions-gh-pages@v4
175175
# If you're changing the branch from main,
176176
# also change the `main` in `refs/heads/main`
177177
# below accordingly.
@@ -201,7 +201,7 @@ A GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in
201201

202202
```yaml
203203
- name: Deploy
204-
uses: peaceiris/actions-gh-pages@v3
204+
uses: peaceiris/actions-gh-pages@v4
205205
with:
206206
github_token: ${{ secrets.GITHUB_TOKEN }}
207207
publish_dir: ./public
@@ -215,7 +215,7 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
215215

216216
```yaml
217217
- name: Deploy
218-
uses: peaceiris/actions-gh-pages@v3
218+
uses: peaceiris/actions-gh-pages@v4
219219
with:
220220
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
221221
publish_dir: ./public
@@ -227,7 +227,7 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
227227

228228
```yaml
229229
- name: Deploy
230-
uses: peaceiris/actions-gh-pages@v3
230+
uses: peaceiris/actions-gh-pages@v4
231231
with:
232232
personal_token: ${{ secrets.PERSONAL_TOKEN }}
233233
publish_dir: ./public
@@ -240,7 +240,7 @@ The default is `gh-pages`.
240240

241241
```yaml
242242
- name: Deploy
243-
uses: peaceiris/actions-gh-pages@v3
243+
uses: peaceiris/actions-gh-pages@v4
244244
with:
245245
github_token: ${{ secrets.GITHUB_TOKEN }}
246246
publish_branch: your-branch # default: gh-pages
@@ -253,7 +253,7 @@ Only the contents of this dir are pushed to GitHub Pages branch, `gh-pages` by d
253253

254254
```yaml
255255
- name: Deploy
256-
uses: peaceiris/actions-gh-pages@v3
256+
uses: peaceiris/actions-gh-pages@v4
257257
with:
258258
github_token: ${{ secrets.GITHUB_TOKEN }}
259259
publish_dir: ./out # default: public
@@ -268,7 +268,7 @@ A destination subdirectory on a publishing branch. The default is empty.
268268

269269
```yaml
270270
- name: Deploy
271-
uses: peaceiris/actions-gh-pages@v3
271+
uses: peaceiris/actions-gh-pages@v4
272272
with:
273273
github_token: ${{ secrets.GITHUB_TOKEN }}
274274
destination_dir: subdir
@@ -285,7 +285,7 @@ Values should be split with a comma.
285285

286286
```yaml
287287
- name: Deploy
288-
uses: peaceiris/actions-gh-pages@v3
288+
uses: peaceiris/actions-gh-pages@v4
289289
with:
290290
github_token: ${{ secrets.GITHUB_TOKEN }}
291291
exclude_assets: '.github,exclude-file1,exclude-file2'
@@ -295,7 +295,7 @@ Set `exclude_assets` to empty for including the `.github` directory to deploymen
295295

296296
```yaml
297297
- name: Deploy
298-
uses: peaceiris/actions-gh-pages@v3
298+
uses: peaceiris/actions-gh-pages@v4
299299
with:
300300
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} # Recommended for this usage
301301
# personal_token: ${{ secrets.PERSONAL_TOKEN }} # An alternative
@@ -307,7 +307,7 @@ The `exclude_assets` option supports glob patterns.
307307

308308
```yaml
309309
- name: Deploy
310-
uses: peaceiris/actions-gh-pages@v3
310+
uses: peaceiris/actions-gh-pages@v4
311311
with:
312312
github_token: ${{ secrets.GITHUB_TOKEN }}
313313
exclude_assets: '.github,exclude-file.txt,exclude-dir/**.txt'
@@ -322,7 +322,7 @@ For more details about the `CNAME` file, read the official documentation: [Manag
322322

323323
```yaml
324324
- name: Deploy
325-
uses: peaceiris/actions-gh-pages@v3
325+
uses: peaceiris/actions-gh-pages@v4
326326
with:
327327
github_token: ${{ secrets.GITHUB_TOKEN }}
328328
publish_dir: ./public
@@ -340,7 +340,7 @@ Bypassing Jekyll makes the deployment faster and is necessary if you are deployi
340340

341341
```yaml
342342
- name: Deploy
343-
uses: peaceiris/actions-gh-pages@v3
343+
uses: peaceiris/actions-gh-pages@v4
344344
with:
345345
github_token: ${{ secrets.GITHUB_TOKEN }}
346346
publish_dir: ./public
@@ -357,7 +357,7 @@ For example:
357357

358358
```yaml
359359
- name: Deploy
360-
uses: peaceiris/actions-gh-pages@v3
360+
uses: peaceiris/actions-gh-pages@v4
361361
with:
362362
github_token: ${{ secrets.GITHUB_TOKEN }}
363363
publish_dir: ./public
@@ -377,7 +377,7 @@ For example:
377377

378378
```yaml
379379
- name: Deploy
380-
uses: peaceiris/actions-gh-pages@v3
380+
uses: peaceiris/actions-gh-pages@v4
381381
with:
382382
github_token: ${{ secrets.GITHUB_TOKEN }}
383383
publish_dir: ./public
@@ -396,7 +396,7 @@ For example:
396396

397397
```yaml
398398
- name: Deploy
399-
uses: peaceiris/actions-gh-pages@v3
399+
uses: peaceiris/actions-gh-pages@v4
400400
with:
401401
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
402402
external_repository: username/external-repository
@@ -423,7 +423,7 @@ This allows you to make your publish branch with only the latest commit.
423423

424424
```yaml
425425
- name: Deploy
426-
uses: peaceiris/actions-gh-pages@v3
426+
uses: peaceiris/actions-gh-pages@v4
427427
with:
428428
github_token: ${{ secrets.GITHUB_TOKEN }}
429429
publish_dir: ./public
@@ -437,7 +437,7 @@ A commit is always created with the same user.
437437

438438
```yaml
439439
- name: Deploy
440-
uses: peaceiris/actions-gh-pages@v3
440+
uses: peaceiris/actions-gh-pages@v4
441441
with:
442442
github_token: ${{ secrets.GITHUB_TOKEN }}
443443
publish_dir: ./public
@@ -454,7 +454,7 @@ When we create a commit with a message `docs: Update some post`, a deployment co
454454

455455
```yaml
456456
- name: Deploy
457-
uses: peaceiris/actions-gh-pages@v3
457+
uses: peaceiris/actions-gh-pages@v4
458458
with:
459459
github_token: ${{ secrets.GITHUB_TOKEN }}
460460
publish_dir: ./public
@@ -468,7 +468,7 @@ use the `full_commit_message` option instead of the `commit_message` option.
468468

469469
```yaml
470470
- name: Deploy
471-
uses: peaceiris/actions-gh-pages@v3
471+
uses: peaceiris/actions-gh-pages@v4
472472
with:
473473
github_token: ${{ secrets.GITHUB_TOKEN }}
474474
publish_dir: ./public
@@ -508,7 +508,7 @@ jobs:
508508
echo "DEPLOY_TAG_NAME=deploy-${TAG_NAME}" >> "${GITHUB_OUTPUT}"
509509
510510
- name: Deploy
511-
uses: peaceiris/actions-gh-pages@v3
511+
uses: peaceiris/actions-gh-pages@v4
512512
with:
513513
github_token: ${{ secrets.GITHUB_TOKEN }}
514514
publish_dir: ./public
@@ -666,7 +666,7 @@ Our project builds and provides build assets only when creating a release. This
666666
In this project, a major tag (e.g. v3) is guaranteed to contain no breaking changes. But, we recommend using a tag or a commit hash for the stability of your workflows.
667667

668668
```yaml
669-
- uses: peaceiris/actions-gh-pages@v3.9.3 # tag: Better
669+
- uses: peaceiris/actions-gh-pages@v4.0.0 # tag: Better
670670
with:
671671
github_token: ${{ secrets.GITHUB_TOKEN }}
672672
publish_dir: ./public
@@ -751,7 +751,7 @@ jobs:
751751
- run: npm run build
752752
753753
- name: Deploy
754-
uses: peaceiris/actions-gh-pages@v3
754+
uses: peaceiris/actions-gh-pages@v4
755755
if: github.ref == 'refs/heads/main'
756756
with:
757757
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -803,7 +803,7 @@ jobs:
803803
- run: npm run build
804804
805805
- name: Deploy
806-
uses: peaceiris/actions-gh-pages@v3
806+
uses: peaceiris/actions-gh-pages@v4
807807
if: github.ref == 'refs/heads/main'
808808
with:
809809
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -858,7 +858,7 @@ jobs:
858858
- run: yarn export
859859
860860
- name: Deploy
861-
uses: peaceiris/actions-gh-pages@v3
861+
uses: peaceiris/actions-gh-pages@v4
862862
if: github.ref == 'refs/heads/main'
863863
with:
864864
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -911,7 +911,7 @@ jobs:
911911
- run: npm run generate
912912
913913
- name: deploy
914-
uses: peaceiris/actions-gh-pages@v3
914+
uses: peaceiris/actions-gh-pages@v4
915915
if: github.ref == 'refs/heads/main'
916916
with:
917917
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -972,7 +972,7 @@ jobs:
972972
- run: yarn build
973973
974974
- name: Deploy
975-
uses: peaceiris/actions-gh-pages@v3
975+
uses: peaceiris/actions-gh-pages@v4
976976
if: github.ref == 'refs/heads/main'
977977
with:
978978
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1036,7 +1036,7 @@ jobs:
10361036
- run: mkdocs build
10371037
10381038
- name: Deploy
1039-
uses: peaceiris/actions-gh-pages@v3
1039+
uses: peaceiris/actions-gh-pages@v4
10401040
if: github.ref == 'refs/heads/main'
10411041
with:
10421042
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1079,7 +1079,7 @@ jobs:
10791079
- run: mdbook build
10801080
10811081
- name: Deploy
1082-
uses: peaceiris/actions-gh-pages@v3
1082+
uses: peaceiris/actions-gh-pages@v4
10831083
if: github.ref == 'refs/heads/main'
10841084
with:
10851085
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1129,7 +1129,7 @@ jobs:
11291129
run: flutter build web
11301130
11311131
- name: Deploy
1132-
uses: peaceiris/actions-gh-pages@v3
1132+
uses: peaceiris/actions-gh-pages@v4
11331133
if: github.ref == 'refs/heads/main'
11341134
with:
11351135
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1180,7 +1180,7 @@ jobs:
11801180
# provide --output=<output-file> option for `elm make` and remove this step
11811181

11821182
- name: Deploy
1183-
uses: peaceiris/actions-gh-pages@v3
1183+
uses: peaceiris/actions-gh-pages@v4
11841184
if: github.ref == 'refs/heads/main'
11851185
with:
11861186
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1233,7 +1233,7 @@ jobs:
12331233
- run: publish-cli generate
12341234

12351235
- name: Deploy to GitHub Pages
1236-
uses: peaceiris/actions-gh-pages@v3
1236+
uses: peaceiris/actions-gh-pages@v4
12371237
if: github.ref == 'refs/heads/main'
12381238
with:
12391239
github_token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)