feat: Add destination_dir option (#403)

Related to #324 #390
This commit is contained in:
Shohei Ueda
2020-07-21 11:15:53 +09:00
committed by GitHub
parent 0cb61e91a5
commit f30118c78e
9 changed files with 93 additions and 20 deletions

View File

@@ -74,6 +74,7 @@ All Actions runners: Linux (Ubuntu), macOS, and Windows are supported.
- [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
- [⭐️ `publish_branch`](#%EF%B8%8F-publish_branch)
- [⭐️ `publish_dir`](#%EF%B8%8F-publish_dir)
- [⭐️ `destination_dir`](#%EF%B8%8F-destination_dir)
- [⭐️ CNAME](#%EF%B8%8F-cname)
- [⭐️ Enable Built-in Jekyll](#%EF%B8%8F-enable-built-in-jekyll)
- [⭐️ Allow empty commits](#%EF%B8%8F-allow-empty-commits)
@@ -255,7 +256,7 @@ A target branch to deploy to GitHub Pages. The default is `gh-pages`.
### ⭐️ `publish_dir`
A target directory to deploy to GitHub Pages. The default is `public`.
A source directory to deploy to GitHub Pages. The default is `public`.
```yaml
- name: Deploy
@@ -265,6 +266,18 @@ A target directory to deploy to GitHub Pages. The default is `public`.
publish_dir: ./out # default: public
```
### ⭐️ `destination_dir`
A destination subdirectory on a publishing branch. The default is empty.
```yaml
- name: Deploy
uses: peaceiris/actions-gh-pages@v3.7.0-0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
destination_dir: subdir
```
### ⭐️ CNAME
To add `CNAME` file, we can set the `cname` option.