You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- [⭐️ Deploy to external repository `external_repository`](#%EF%B8%8F-deploy-to-external-repository-external_repository)
83
+
- [⭐️ Force orphan `force_orphan`](#%EF%B8%8F-force-orphan-force_orphan)
84
84
- [⭐️ Set Git username and email](#%EF%B8%8F-set-git-username-and-email)
85
85
- [⭐️ Set custom commit message](#%EF%B8%8F-set-custom-commit-message)
86
86
- [⭐️ Create Git tag](#%EF%B8%8F-create-git-tag)
@@ -201,7 +201,7 @@ jobs:
201
201
202
202
## Options
203
203
204
-
### ⭐️ `github_token`
204
+
### ⭐️ Set Runner's Access Token `github_token`
205
205
206
206
**This option is for `GITHUB_TOKEN`, not a personal access token.**
207
207
@@ -217,7 +217,7 @@ GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in yo
217
217
218
218
For more details about `GITHUB_TOKEN`: [Authenticating with the GITHUB_TOKEN - GitHub Help](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
219
219
220
-
### ⭐️ `deploy_key`
220
+
### ⭐️ Set SSH Private Key `deploy_key`
221
221
222
222
Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH deploy key, and set the `deploy_key` option like the following.
[Generate a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.
A target branch to deploy to GitHub Pages. The default is `gh-pages`.
248
247
@@ -254,7 +253,7 @@ A target branch to deploy to GitHub Pages. The default is `gh-pages`.
254
253
publish_branch: master # default: gh-pages
255
254
```
256
255
257
-
### ⭐️ `publish_dir`
256
+
### ⭐️ Source Directory `publish_dir`
258
257
259
258
A source directory to deploy to GitHub Pages. The default is `public`.
260
259
@@ -266,7 +265,10 @@ A source directory to deploy to GitHub Pages. The default is `public`.
266
265
publish_dir: ./out # default: public
267
266
```
268
267
269
-
### ⭐️ `destination_dir`
268
+
### ⭐️ Deploy to Subdirectory `destination_dir`
269
+
270
+
*This feature is on beta.*
271
+
*Any feedback is welcome at [Issue #324](https://github.com/peaceiris/actions-gh-pages/issues/324)*
270
272
271
273
A destination subdirectory on a publishing branch. The default is empty.
272
274
@@ -278,7 +280,7 @@ A destination subdirectory on a publishing branch. The default is empty.
278
280
destination_dir: subdir
279
281
```
280
282
281
-
### ⭐️ CNAME
283
+
### ⭐️ Add CNAME file `cname`
282
284
283
285
To add `CNAME` file, we can set the `cname` option.
284
286
@@ -293,7 +295,7 @@ For more details about `CNAME`, read the official documentation: [Managing a cus
293
295
cname: github.com
294
296
```
295
297
296
-
### ⭐️ Enable Built-in Jekyll
298
+
### ⭐️ Enable Built-in Jekyll `enable_jekyll`
297
299
298
300
If you want GitHub Pages to process your site with the static site generator Jekyll, set `enable_jekyll` to true.
299
301
@@ -315,7 +317,7 @@ Bypassing Jekyll makes the deployment faster and is necessary if you are deployi
315
317
316
318
For more details about `.nojekyll`: [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
317
319
318
-
### ⭐️ Allow empty commits
320
+
### ⭐️ Allow empty commits `allow_empty_commit`
319
321
320
322
By default, a commit will not be generated when no file changes. If you want to allow an empty commit, set the optional parameter `allow_empty_commit` to `true`.
321
323
@@ -330,7 +332,7 @@ For example:
330
332
allow_empty_commit: true
331
333
```
332
334
333
-
### ⭐️ Keeping existing files
335
+
### ⭐️ Keeping existing files `keep_files`
334
336
335
337
By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`.
336
338
@@ -345,7 +347,7 @@ For example:
345
347
keep_files: true
346
348
```
347
349
348
-
### ⭐️ Deploy to external repository
350
+
### ⭐️ Deploy to external repository `external_repository`
349
351
350
352
By default, your files are published to the repository which is running this action.
351
353
If you want to publish to another repository on GitHub, set the environment variable `external_repository` to `<username>/<external-repository>`.
@@ -374,7 +376,7 @@ A GitHub Free Plan account cannot use the GitHub Pages in a private repository.
374
376
- `peaceiris/homepage`: A private repository running this action with `external_repository: peaceiris/peaceiris.github.io`
375
377
- `peaceiris/peaceiris.github.io`: A public repository using GitHub Pages
376
378
377
-
### ⭐️ Force orphan
379
+
### ⭐️ Force orphan `force_orphan`
378
380
379
381
We can set the `force_orphan: true` option.
380
382
This allows you to make your publish branch with only the latest commit.
0 commit comments