Skip to content

Commit 727fb69

Browse files
committed
docs: Add new section about Script mode, close #37
1 parent 5897005 commit 727fb69

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
4646
- [⭐️ Suppressing empty commits](#%EF%B8%8F-suppressing-empty-commits)
4747
- [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
4848
- [⭐️ Deploy to external repository](#%EF%B8%8F-deploy-to-external-repository)
49+
- [⭐️ Script mode](#%EF%B8%8F-script-mode)
4950
- [Tips and FAQ](#tips-and-faq)
5051
- [⭐️ Use the latest and specific release](#%EF%B8%8F-use-the-latest-and-specific-release)
5152
- [⭐️ How to add `CNAME`](#%EF%B8%8F-how-to-add-cname)
@@ -265,6 +266,22 @@ When you use `ACTIONS_DEPLOY_KEY`, set your private key to the repository which
265266

266267
Be careful, `GITHUB_TOKEN` has no permission to access to external repositories.
267268

269+
### ⭐️ Script mode
270+
271+
From `v2.5.0`, we can run this action as a shell script.
272+
There is no Docker build or pull step, so it will start immediately.
273+
274+
```yaml
275+
- name: Deploy
276+
env:
277+
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
278+
PUBLISH_BRANCH: gh-pages
279+
PUBLISH_DIR: ./public
280+
run: |
281+
wget https://raw.githubusercontent.com/peaceiris/actions-gh-pages/v2.5.0/entrypoint.sh
282+
bash ./entrypoint.sh
283+
```
284+
268285
<div align="right">
269286
<a href="#table-of-contents">Back to TOC ☝️</a>
270287
</div>

0 commit comments

Comments
 (0)