Compare commits

...

65 Commits

Author SHA1 Message Date
peaceiris
c56c9818a0 chore(release): 3.6.0
Some checks failed
Release / release (push) Has been cancelled
2020-05-04 09:51:27 +09:00
peaceiris
1c794ced3b chore(release): Add build assets 2020-05-04 09:51:26 +09:00
Shohei Ueda
0b7411e2cf feat: Add full_commit_message (#275)
* feat: Add full_commit_message
* ci: Add full_commit_message
* docs: Add full_commit_message

cf. #274
2020-05-04 09:50:38 +09:00
peaceiris
750c807fa1 chore: Enhance style 2020-05-04 00:52:58 +09:00
dependabot-preview[bot]
ae34186caa deps: bump jest from 25.5.3 to 25.5.4 (#272) 2020-05-02 08:30:17 +00:00
dependabot-preview[bot]
a5d411bf28 deps: bump jest-circus from 25.5.3 to 25.5.4 (#271) 2020-05-02 08:23:58 +00:00
peaceiris
2875e4112a Revert "ci: use github_token"
This reverts commit 9d27fac8dc.
2020-05-02 02:25:23 +09:00
Shohei Ueda
9d27fac8dc ci: use github_token 2020-05-02 02:21:22 +09:00
Shohei Ueda
7501463241 ci: Add test-ubuntu-20.04 job (#270)
- Bumps mdBook from 0.3.6 to 0.3.7
- Add test job for ubuntu 20.04

cf. #268
2020-05-01 15:10:19 +09:00
dependabot-preview[bot]
b9cccec41e deps: bump lint-staged from 10.2.1 to 10.2.2 (#269) 2020-05-01 04:44:42 +00:00
dependabot-preview[bot]
e782e1d323 deps: bump jest from 25.5.2 to 25.5.3 (#267) 2020-04-30 22:48:48 +00:00
dependabot-preview[bot]
c12a4b1908 deps: bump jest-circus from 25.5.2 to 25.5.3 (#266) 2020-04-30 22:28:14 +00:00
dependabot-preview[bot]
dd1933a7b4 deps: bump @actions/core from 1.2.3 to 1.2.4 (#265) 2020-04-30 17:21:50 +00:00
dependabot-preview[bot]
08093066ac deps: bump lint-staged from 10.2.0 to 10.2.1 (#264) 2020-04-30 15:00:06 +00:00
peaceiris
c603e10bc1 chore(release): Remove build assets [skip ci] 2020-04-30 23:49:32 +09:00
peaceiris
5fe58fddba chore(release): 3.5.10
Some checks failed
Release / release (push) Has been cancelled
2020-04-30 23:49:31 +09:00
peaceiris
54a4434749 chore(release): Add build assets 2020-04-30 23:49:28 +09:00
Shohei Ueda
20d80bcd8c docs: change to job level defaults
Change workflow level defaults.run.working-directory to job level in Docusaurus example.
2020-04-30 23:48:01 +09:00
Shohei Ueda
d9f616f4a2 docs: Add ubuntu-16.04
cf. #263
2020-04-30 23:42:27 +09:00
Shohei Ueda
e76c874d85 feat: Support ubuntu-16.04 (#263)
* ci: Add ubuntu-16.04
* ci: bump actions/upload-artifact from v1 to v2
* ci: Fix file name for all matrix
2020-04-30 23:36:53 +09:00
Shohei Ueda
029c1a08f9 docs: bump actions/setup-python from v1 to v2 (#262)
https://github.com/actions/setup-python/pull/87
https://github.com/actions/setup-python/pull/85

Testing https://github.com/peaceiris/mkdocs-material-boilerplate/pull/102
2020-04-30 23:13:03 +09:00
Shohei Ueda
eafac7a3ef docs: bump python from 3.6 to 3.8 2020-04-30 17:04:31 +09:00
Shohei Ueda
e4462d9bb6 docs: Enhance Python workflow example (#261)
4e1362e350

ccf9619480
https://github.com/actions/cache/pull/285
2020-04-30 17:03:08 +09:00
Shohei Ueda
91e6658ef0 docs: Enhance Supported Platforms 2020-04-30 16:38:29 +09:00
dependabot-preview[bot]
714f710922 deps: bump jest from 25.5.1 to 25.5.2 (#260) 2020-04-29 22:30:52 +00:00
dependabot-preview[bot]
813be0645e deps: bump jest-circus from 25.5.1 to 25.5.2 (#259) 2020-04-29 22:24:44 +00:00
peaceiris
a580dd75ed chore(release): Remove build assets [skip ci] 2020-04-30 03:07:46 +09:00
peaceiris
cf30185743 chore(release): 3.5.9
Some checks failed
Release / release (push) Has been cancelled
2020-04-30 03:07:45 +09:00
peaceiris
f815420c17 chore(release): Add build assets 2020-04-30 03:07:44 +09:00
peaceiris
e5aa21b8a8 chore: bump node from 12.16.2 to 12.16.3 2020-04-30 03:07:14 +09:00
dependabot-preview[bot]
d2178821cb deps: [security] bump @actions/http-client from 1.0.6 to 1.0.8 (#258) 2020-04-29 18:04:52 +00:00
dependabot-preview[bot]
6462e1bf5e deps: bump jest from 25.5.0 to 25.5.1 (#257) 2020-04-29 13:53:47 +00:00
dependabot-preview[bot]
051ddfc79a deps: bump jest-circus from 25.5.0 to 25.5.1 (#256) 2020-04-29 13:16:23 +00:00
Shohei Ueda
f191fb8187 deps: bump node from 12.16.2 to 12.16.3 (#255) 2020-04-29 15:34:00 +09:00
dependabot-preview[bot]
6cb5962c01 deps: bump @actions/exec from 1.0.3 to 1.0.4 (#254) 2020-04-29 05:23:43 +00:00
dependabot-preview[bot]
33b82d2be0 deps: bump prettier from 2.0.4 to 2.0.5 (#253) 2020-04-29 05:16:42 +00:00
peaceiris
a2c82a8833 chore(release): Remove build assets [skip ci] 2020-04-29 13:53:02 +09:00
peaceiris
286809f3da chore(release): 3.5.8
Some checks failed
Release / release (push) Has been cancelled
2020-04-29 13:53:01 +09:00
peaceiris
5e3936a404 chore(release): Add build assets 2020-04-29 13:53:00 +09:00
dependabot-preview[bot]
f97b3d256e deps: bump @typescript-eslint/eslint-plugin from 2.28.0 to 2.30.0 (#252) 2020-04-29 04:15:11 +00:00
dependabot-preview[bot]
7b01d765e7 deps: bump @types/node from 12.12.36 to 12.12.37 (#251) 2020-04-29 04:03:20 +00:00
dependabot-preview[bot]
4976317340 deps: bump lint-staged from 10.1.6 to 10.2.0 (#250) 2020-04-29 03:50:29 +00:00
dependabot-preview[bot]
28e7732e93 deps: bump @typescript-eslint/parser from 2.28.0 to 2.30.0 (#249) 2020-04-29 02:21:55 +00:00
dependabot-preview[bot]
390b063535 deps: bump jest from 25.3.0 to 25.5.0 (#248) 2020-04-28 20:25:54 +00:00
dependabot-preview[bot]
50bcf7b81d deps: bump jest-circus from 25.3.0 to 25.5.0 (#247) 2020-04-28 20:04:15 +00:00
Shohei Ueda
1511f85feb docs: Enhance the Tips and FAQ section
- Enhance `First Deployment with GITHUB_TOKEN`
2020-04-28 14:25:48 +09:00
Shohei Ueda
db7681db4d deps: bump git from 2.26.1 to 2.26.2 (#246) 2020-04-25 23:06:07 +09:00
peaceiris
eda4527add chore: Add issue priority [skip ci] 2020-04-23 12:55:35 +09:00
peaceiris
0ab035e1c1 Revert "chore: Add issue priority [skip ci]"
This reverts commit af61d81606.
2020-04-23 12:53:19 +09:00
Shohei Ueda
af61d81606 chore: Add issue priority [skip ci] 2020-04-23 12:52:32 +09:00
Shohei Ueda
86114bb2c7 chore: update [skip ci] 2020-04-23 12:44:24 +09:00
Shohei Ueda
1139364d4c chore: enhance about [skip ci] 2020-04-23 12:43:08 +09:00
Shohei Ueda
e3404eb04b ci: Add hook for doctoc (#244) 2020-04-22 13:33:06 +09:00
dependabot-preview[bot]
c1bc06c3e6 deps: bump lint-staged from 10.1.5 to 10.1.6 (#241) 2020-04-19 09:43:53 +00:00
peaceiris
8632feabc7 docs: update 2020-04-19 14:14:03 +09:00
peaceiris
7d421d3e4c docs: update 2020-04-19 14:11:37 +09:00
peaceiris
95d87cfaa5 docs: update 2020-04-19 11:44:23 +09:00
dependabot-preview[bot]
cfc119fff7 deps: bump lint-staged from 10.1.4 to 10.1.5 (#240) 2020-04-18 08:29:08 +00:00
Shohei Ueda
4b0ac9453b docs: Add publish_branch and publish_dir (#239) 2020-04-18 14:30:22 +09:00
dependabot-preview[bot]
b7c9581509 deps: bump @types/node from 12.12.35 to 12.12.36 (#238) 2020-04-17 21:45:30 +00:00
dependabot-preview[bot]
fd97637134 deps: bump lint-staged from 10.1.3 to 10.1.4 (#237) 2020-04-17 14:48:13 +00:00
dependabot-preview[bot]
f69bcb9ae8 deps: bump ts-jest from 25.3.1 to 25.4.0 (#236) 2020-04-17 10:14:29 +00:00
Shohei Ueda
f1ebad9abb docs: Enhance cache key (#235) 2020-04-17 09:53:26 +09:00
Shohei Ueda
63cdebd96b docs: Enhance Docusaurus example workflow (#234)
- Add on.push.paths
- Add defaults.run.working-directory
  - https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#defaultsrun
  - https://github.blog/changelog/2020-04-15-github-actions-new-workflow-features/
2020-04-17 09:27:11 +09:00
peaceiris
4f693f0ddb chore(release): Remove build assets [skip ci] 2020-04-15 10:55:53 +09:00
18 changed files with 1683 additions and 1722 deletions

View File

@@ -1,31 +1,31 @@
---
name: User support
about: Questions for this action
name: User Support
about: Questions for this Action
title: 'sample_title'
labels: support
assignees: peaceiris
---
**Check list before opening this issue**
### Check list before opening this issue
- [ ] I read the latest README
- I checked [Available Options](https://github.com/peaceiris/actions-gh-pages#options)
- I followed [Tips and FAQ](https://github.com/peaceiris/actions-gh-pages#tips-and-faq)
- I tried [Workflow Examples](https://github.com/peaceiris/actions-gh-pages#examples)
**Describe your question**
### Describe your question
A clear and concise description of what the question is.
**Link to your contents**
### Link to your contents
- Link to your public repository here
- Link to your workflow here
**Screenshots**
### Screenshots
If applicable, add screenshots to help explain your question.
**Additional context**
### Additional context
Add any other context about the problem here.

View File

@@ -1,31 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
name: Bug Report
about: First, use the User Support Issue Template
title: 'sample_title'
labels: bug
assignees: peaceiris
---
**Describe the bug**
### Describe the bug
A clear and concise description of what the bug is.
**To Reproduce**
### To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
### Expected behavior
A clear and concise description of what you expected to happen.
**Screenshots**
### Screenshots
If applicable, add screenshots to help explain your problem.
**Your YAML file**
### Your YAML file
- A link to your repository
- A link to your YAML file
**Additional context**
### Additional context
Add any other context about the problem here.

View File

@@ -7,14 +7,18 @@ assignees: peaceiris
---
**Is your feature request related to a problem? Please describe.**
### Is your feature request related to a problem? Please describe
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
### Describe the solution you'd like
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
### Additional context
Add any other context or screenshots about the feature request here.

View File

@@ -26,6 +26,7 @@ jobs:
matrix:
os:
- 'ubuntu-18.04'
- 'ubuntu-16.04'
- 'macos-latest'
- 'windows-latest'
steps:
@@ -56,19 +57,19 @@ jobs:
- run: npm ci
- name: Run prettier
if: startsWith(matrix.os, 'ubuntu')
if: startsWith(matrix.os, 'ubuntu-18.04')
run: npm run format:check
- name: Run eslint
if: startsWith(matrix.os, 'ubuntu')
if: startsWith(matrix.os, 'ubuntu-18.04')
run: npm run lint
- run: npm test
- name: Upload test coverage as artifact
uses: actions/upload-artifact@v1
uses: actions/upload-artifact@v2
with:
name: coverage
name: coverage-${{ matrix.os }}
path: coverage
- uses: codecov/codecov-action@v1
@@ -88,7 +89,7 @@ jobs:
if: github.ref == 'refs/heads/master'
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: '0.3.6'
mdbook-version: '0.3.7'
- name: Build site
if: github.ref == 'refs/heads/master'
@@ -97,7 +98,7 @@ jobs:
- name: Deploy
if: |
startsWith(matrix.os, 'ubuntu') &&
startsWith(matrix.os, 'ubuntu-18.04') &&
github.ref == 'refs/heads/master'
uses: ./
with:
@@ -114,6 +115,24 @@ jobs:
# commit_message: ${{ github.event.head_commit.message }}
cname: 'actions-gh-pages.peaceiris.com'
- name: Deploy
if: |
startsWith(matrix.os, 'ubuntu-16.04') &&
github.ref == 'refs/heads/master'
uses: ./
with:
# deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages-ubuntu-16.04
publish_dir: ./test_projects/mdbook/book
# external_repository: ''
allow_empty_commit: true
keep_files: true
force_orphan: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
full_commit_message: ${{ github.event.head_commit.message }}
- name: Deploy
if: |
startsWith(matrix.os, 'macos') &&
@@ -151,3 +170,82 @@ jobs:
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
# commit_message: ${{ github.event.head_commit.message }}
test-ubuntu-2004:
runs-on: 'ubuntu-18.04'
if: contains(github.event.head_commit.message, '[skip ci]') == false
container:
image: 'ubuntu:20.04'
steps:
- name: Install deps
run: |
apt update
apt install -y software-properties-common
add-apt-repository ppa:git-core/ppa
apt update
apt install -y \
git \
ssh
- uses: actions/checkout@v2
- name: Dump GitHub context
env:
GITHUB_CONTEXT: ${{ toJson(github) }}
run: echo "${GITHUB_CONTEXT}"
- name: Read .nvmrc
run: echo "::set-output name=NVMRC::$(cat .nvmrc)"
id: nvm
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: '${{ steps.nvm.outputs.NVMRC }}'
- run: npm i -g npm
- name: Dump version
run: |
node -v
npm --version
git --version
- run: npm ci
- run: npm test
- name: Run ncc
run: npm run build
- name: Remove lint-staged husky
if: github.ref == 'refs/heads/master'
run: |
npm uninstall lint-staged husky
git checkout package-lock.json package.json
- name: Setup mdBook
if: github.ref == 'refs/heads/master'
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: '0.3.7'
- name: Build site
if: github.ref == 'refs/heads/master'
working-directory: ./test_projects/mdbook
run: mdbook build
- name: Deploy
if: github.ref == 'refs/heads/master'
uses: ./
with:
# deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages-ubuntu-20.04
publish_dir: ./test_projects/mdbook/book
# external_repository: ''
allow_empty_commit: true
# keep_files: true
# force_orphan: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
# commit_message: ${{ github.event.head_commit.message }}

2
.nvmrc
View File

@@ -1 +1 @@
12.16.2
12.16.3

View File

@@ -2,6 +2,116 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
# [3.6.0](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.10...v3.6.0) (2020-05-04)
### chore
* Enhance style ([750c807](https://github.com/peaceiris/actions-gh-pages/commit/750c807fa1ecf9d3d455cfd0fb5533442c660a1e))
### ci
* Add test-ubuntu-20.04 job (#270) ([7501463](https://github.com/peaceiris/actions-gh-pages/commit/75014632413b319cb87db5b3e54bba2d6a21ac05)), closes [#270](https://github.com/peaceiris/actions-gh-pages/issues/270) [#268](https://github.com/peaceiris/actions-gh-pages/issues/268)
* use github_token ([9d27fac](https://github.com/peaceiris/actions-gh-pages/commit/9d27fac8dcdc50937d59b3068c59acf257ad2398))
### deps
* bump @actions/core from 1.2.3 to 1.2.4 (#265) ([dd1933a](https://github.com/peaceiris/actions-gh-pages/commit/dd1933a7b4b77a06b1995b0e8c40b6c219f32550)), closes [#265](https://github.com/peaceiris/actions-gh-pages/issues/265)
* bump jest from 25.5.2 to 25.5.3 (#267) ([e782e1d](https://github.com/peaceiris/actions-gh-pages/commit/e782e1d32332c2e99058a039dd5caaf0533d0af6)), closes [#267](https://github.com/peaceiris/actions-gh-pages/issues/267)
* bump jest from 25.5.3 to 25.5.4 (#272) ([ae34186](https://github.com/peaceiris/actions-gh-pages/commit/ae34186caa187c2960bae6d656f6ef69c6aa0fba)), closes [#272](https://github.com/peaceiris/actions-gh-pages/issues/272)
* bump jest-circus from 25.5.2 to 25.5.3 (#266) ([c12a4b1](https://github.com/peaceiris/actions-gh-pages/commit/c12a4b1908457ab10af84e0947b66af3f868790c)), closes [#266](https://github.com/peaceiris/actions-gh-pages/issues/266)
* bump jest-circus from 25.5.3 to 25.5.4 (#271) ([a5d411b](https://github.com/peaceiris/actions-gh-pages/commit/a5d411bf285983883daecb16787a8f6549da66d8)), closes [#271](https://github.com/peaceiris/actions-gh-pages/issues/271)
* bump lint-staged from 10.2.0 to 10.2.1 (#264) ([0809306](https://github.com/peaceiris/actions-gh-pages/commit/08093066ac77639e402a4b60492a7759c395ba36)), closes [#264](https://github.com/peaceiris/actions-gh-pages/issues/264)
* bump lint-staged from 10.2.1 to 10.2.2 (#269) ([b9cccec](https://github.com/peaceiris/actions-gh-pages/commit/b9cccec41e2e47ef704d34a7409dc07a50e32d46)), closes [#269](https://github.com/peaceiris/actions-gh-pages/issues/269)
### feat
* Add full_commit_message (#275) ([0b7411e](https://github.com/peaceiris/actions-gh-pages/commit/0b7411e2cf05b033f6766798560d02e932e01bd2)), closes [#275](https://github.com/peaceiris/actions-gh-pages/issues/275) [#274](https://github.com/peaceiris/actions-gh-pages/issues/274)
## [3.5.10](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.9...v3.5.10) (2020-04-30)
### deps
* bump jest from 25.5.1 to 25.5.2 (#260) ([714f710](https://github.com/peaceiris/actions-gh-pages/commit/714f7109225b609d3303bb0cd6f459690a9165b6)), closes [#260](https://github.com/peaceiris/actions-gh-pages/issues/260)
* bump jest-circus from 25.5.1 to 25.5.2 (#259) ([813be06](https://github.com/peaceiris/actions-gh-pages/commit/813be0645e175e6e475ada4f9cc922daeeade00a)), closes [#259](https://github.com/peaceiris/actions-gh-pages/issues/259)
### docs
* Add ubuntu-16.04 ([d9f616f](https://github.com/peaceiris/actions-gh-pages/commit/d9f616f4a278b6c334ce6dea09e69ba698459b38)), closes [#263](https://github.com/peaceiris/actions-gh-pages/issues/263)
* bump actions/setup-python from v1 to v2 (#262) ([029c1a0](https://github.com/peaceiris/actions-gh-pages/commit/029c1a08f9594e3b2c581d78c258cc8e9c66f96c)), closes [#262](https://github.com/peaceiris/actions-gh-pages/issues/262)
* bump python from 3.6 to 3.8 ([eafac7a](https://github.com/peaceiris/actions-gh-pages/commit/eafac7a3ef405ea76543c2c7995b64a19a1695c0))
* change to job level defaults ([20d80bc](https://github.com/peaceiris/actions-gh-pages/commit/20d80bcd8cdfda9728f3c0befe2aa5052209ea50))
* Enhance Python workflow example (#261) ([e4462d9](https://github.com/peaceiris/actions-gh-pages/commit/e4462d9bb679154cb07cca446c8e12c692610838)), closes [#261](https://github.com/peaceiris/actions-gh-pages/issues/261)
* Enhance Supported Platforms ([91e6658](https://github.com/peaceiris/actions-gh-pages/commit/91e6658ef01bbd482a965675988a765faad5fce5))
### feat
* Support ubuntu-16.04 (#263) ([e76c874](https://github.com/peaceiris/actions-gh-pages/commit/e76c874d85f0c0e45f3602fe4a85a15feb87610c)), closes [#263](https://github.com/peaceiris/actions-gh-pages/issues/263)
## [3.5.9](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.8...v3.5.9) (2020-04-29)
### chore
* bump node from 12.16.2 to 12.16.3 ([e5aa21b](https://github.com/peaceiris/actions-gh-pages/commit/e5aa21b8a847df106ce694432a6cac78300266a3))
### deps
* [security] bump @actions/http-client from 1.0.6 to 1.0.8 (#258) ([d217882](https://github.com/peaceiris/actions-gh-pages/commit/d2178821cb5968f5b7c818210297f3dbeea3114c)), closes [#258](https://github.com/peaceiris/actions-gh-pages/issues/258)
* bump @actions/exec from 1.0.3 to 1.0.4 (#254) ([6cb5962](https://github.com/peaceiris/actions-gh-pages/commit/6cb5962c014ba1196680337447c834590d907bde)), closes [#254](https://github.com/peaceiris/actions-gh-pages/issues/254)
* bump jest from 25.5.0 to 25.5.1 (#257) ([6462e1b](https://github.com/peaceiris/actions-gh-pages/commit/6462e1bf5e8ba9325ae66bacba198b12c7e101ed)), closes [#257](https://github.com/peaceiris/actions-gh-pages/issues/257)
* bump jest-circus from 25.5.0 to 25.5.1 (#256) ([051ddfc](https://github.com/peaceiris/actions-gh-pages/commit/051ddfc79a0bbbdd8e623367741645052c63fb9a)), closes [#256](https://github.com/peaceiris/actions-gh-pages/issues/256)
* bump node from 12.16.2 to 12.16.3 (#255) ([f191fb8](https://github.com/peaceiris/actions-gh-pages/commit/f191fb81878aaa8657d346e9b3a97a4ad625939d)), closes [#255](https://github.com/peaceiris/actions-gh-pages/issues/255)
* bump prettier from 2.0.4 to 2.0.5 (#253) ([33b82d2](https://github.com/peaceiris/actions-gh-pages/commit/33b82d2be041389aa51ca38f09cf6e79a9129035)), closes [#253](https://github.com/peaceiris/actions-gh-pages/issues/253)
## [3.5.8](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.7...v3.5.8) (2020-04-29)
### chore
* Add issue priority [skip ci] ([eda4527](https://github.com/peaceiris/actions-gh-pages/commit/eda4527addb918b2101150ebb39fcf433918edaa))
* Add issue priority [skip ci] ([af61d81](https://github.com/peaceiris/actions-gh-pages/commit/af61d81606e4fc7e288136ff2d253e2bc55c4f48))
* enhance about [skip ci] ([1139364](https://github.com/peaceiris/actions-gh-pages/commit/1139364d4c33266789f7b3325cf9a44a8547dfd2))
* update [skip ci] ([86114bb](https://github.com/peaceiris/actions-gh-pages/commit/86114bb2c7af49107a982228b5bdb03680d01f4d))
### ci
* Add hook for doctoc (#244) ([e3404eb](https://github.com/peaceiris/actions-gh-pages/commit/e3404eb04b31f2987120c926fea07b0213caebd8)), closes [#244](https://github.com/peaceiris/actions-gh-pages/issues/244)
### deps
* bump @types/node from 12.12.35 to 12.12.36 (#238) ([b7c9581](https://github.com/peaceiris/actions-gh-pages/commit/b7c9581509f430da7d5fd97e37245a2d0a66b564)), closes [#238](https://github.com/peaceiris/actions-gh-pages/issues/238)
* bump @types/node from 12.12.36 to 12.12.37 (#251) ([7b01d76](https://github.com/peaceiris/actions-gh-pages/commit/7b01d765e76fa62e2452fd444f2b4c27a2a93821)), closes [#251](https://github.com/peaceiris/actions-gh-pages/issues/251)
* bump @typescript-eslint/eslint-plugin from 2.28.0 to 2.30.0 (#252) ([f97b3d2](https://github.com/peaceiris/actions-gh-pages/commit/f97b3d256ec802bf086d5c96dcb299a63b38f705)), closes [#252](https://github.com/peaceiris/actions-gh-pages/issues/252)
* bump @typescript-eslint/parser from 2.28.0 to 2.30.0 (#249) ([28e7732](https://github.com/peaceiris/actions-gh-pages/commit/28e7732e93caf2520c542d47eb7482a09d92399d)), closes [#249](https://github.com/peaceiris/actions-gh-pages/issues/249)
* bump git from 2.26.1 to 2.26.2 (#246) ([db7681d](https://github.com/peaceiris/actions-gh-pages/commit/db7681db4d6bba0e054efa7da8d6494f40aa74dd)), closes [#246](https://github.com/peaceiris/actions-gh-pages/issues/246)
* bump jest from 25.3.0 to 25.5.0 (#248) ([390b063](https://github.com/peaceiris/actions-gh-pages/commit/390b063535b4dc9533b19e2bdc0a5c756725bcd3)), closes [#248](https://github.com/peaceiris/actions-gh-pages/issues/248)
* bump jest-circus from 25.3.0 to 25.5.0 (#247) ([50bcf7b](https://github.com/peaceiris/actions-gh-pages/commit/50bcf7b81dbedbab7f9d8c9cebc15c1d63724e52)), closes [#247](https://github.com/peaceiris/actions-gh-pages/issues/247)
* bump lint-staged from 10.1.3 to 10.1.4 (#237) ([fd97637](https://github.com/peaceiris/actions-gh-pages/commit/fd976371344295a7f93bf199bc5557ef179ccb8c)), closes [#237](https://github.com/peaceiris/actions-gh-pages/issues/237)
* bump lint-staged from 10.1.4 to 10.1.5 (#240) ([cfc119f](https://github.com/peaceiris/actions-gh-pages/commit/cfc119fff765ff9d58364aaacc6f3eeda2cfa803)), closes [#240](https://github.com/peaceiris/actions-gh-pages/issues/240)
* bump lint-staged from 10.1.5 to 10.1.6 (#241) ([c1bc06c](https://github.com/peaceiris/actions-gh-pages/commit/c1bc06c3e6c64d6663aaaddce19c3092f44fee76)), closes [#241](https://github.com/peaceiris/actions-gh-pages/issues/241)
* bump lint-staged from 10.1.6 to 10.2.0 (#250) ([4976317](https://github.com/peaceiris/actions-gh-pages/commit/4976317340cc18cda0238fb97829a0faaa845961)), closes [#250](https://github.com/peaceiris/actions-gh-pages/issues/250)
* bump ts-jest from 25.3.1 to 25.4.0 (#236) ([f69bcb9](https://github.com/peaceiris/actions-gh-pages/commit/f69bcb9ae88328fdbf841072c8d6273cd64775d0)), closes [#236](https://github.com/peaceiris/actions-gh-pages/issues/236)
### docs
* Add publish_branch and publish_dir (#239) ([4b0ac94](https://github.com/peaceiris/actions-gh-pages/commit/4b0ac9453b6b8c117d2d477feec9438cbadde554)), closes [#239](https://github.com/peaceiris/actions-gh-pages/issues/239)
* Enhance cache key (#235) ([f1ebad9](https://github.com/peaceiris/actions-gh-pages/commit/f1ebad9abbd9a38f40b3bf1731c8f24d11933c7f)), closes [#235](https://github.com/peaceiris/actions-gh-pages/issues/235)
* Enhance Docusaurus example workflow (#234) ([63cdebd](https://github.com/peaceiris/actions-gh-pages/commit/63cdebd96bf13f045ac949edf7242044ecfef525)), closes [#234](https://github.com/peaceiris/actions-gh-pages/issues/234)
* Enhance the Tips and FAQ section ([1511f85](https://github.com/peaceiris/actions-gh-pages/commit/1511f85febf4d985083555b7e644fc43582ec4ee))
* update ([8632fea](https://github.com/peaceiris/actions-gh-pages/commit/8632feabc7064b8023ffa7da92bf6d91cf83a0fe))
* update ([7d421d3](https://github.com/peaceiris/actions-gh-pages/commit/7d421d3e4c784eaebafdf020ccf4ce29ac14569a))
* update ([95d87cf](https://github.com/peaceiris/actions-gh-pages/commit/95d87cfaa53b3d799c1c931048a43a92ddb87d15))
## [3.5.7](https://github.com/peaceiris/actions-gh-pages/compare/v3.5.6...v3.5.7) (2020-04-15)

View File

@@ -16,7 +16,7 @@ RUN apt-get update && \
npm i -g npm
WORKDIR /git
ENV GIT_VERSION="2.26.1"
ENV GIT_VERSION="2.26.2"
RUN wget -q "https://github.com/git/git/archive/v${GIT_VERSION}.tar.gz" && \
tar -zxf "./v${GIT_VERSION}.tar.gz" && \
rm "./v${GIT_VERSION}.tar.gz" && \

View File

@@ -16,7 +16,7 @@ The old Docker Action is [peaceiris/actions-gh-pages@v2](https://github.com/peac
## GitHub Actions for GitHub Pages
This is a **GitHub Action** to deploy your static files to **GitHub Pages**.
This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, mdBook, etc.)
This deploy action can be combined simply and freely with [Static Site Generators]. (Hugo, MkDocs, Gatsby, GitBook, mdBook, and so on.)
[Static Site Generators]: https://www.staticgen.com/
@@ -45,9 +45,12 @@ Notes: Actually, the `GITHUB_TOKEN` works for deploying to GitHub Pages but it h
### Supported Platforms
All Actions runners: Linux (Ubuntu), macOS, and Windows are supported.
| runs-on | `github_token` | `deploy_key` | `personal_token` |
|---|:---:|:---:|:---:|
| ubuntu-18.04 | ✅️ | ✅️ | ✅️ |
| ubuntu-16.04 | ✅️ | ✅️ | ✅️ |
| macos-latest | ✅️ | ✅️ | ✅️ |
| windows-latest | ✅️ | (2) | ✅️ |
@@ -68,6 +71,8 @@ Notes: Actually, the `GITHUB_TOKEN` works for deploying to GitHub Pages but it h
- [⭐️ `github_token`](#%EF%B8%8F-github_token)
- [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
- [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
- [⭐️ `publish_branch`](#%EF%B8%8F-publish_branch)
- [⭐️ `publish_dir`](#%EF%B8%8F-publish_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)
@@ -234,6 +239,30 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
publish_dir: ./public
```
### ⭐️ `publish_branch`
A target branch to deploy to GitHub Pages. The default is `gh-pages`.
```yaml
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: master # default: gh-pages
```
### ⭐️ `publish_dir`
A target directory to deploy to GitHub Pages. The default is `public`.
```yaml
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./out # default: public
```
### ⭐️ CNAME
To add `CNAME` file, we can set the `cname` option.
@@ -368,6 +397,18 @@ When we create a commit with a message `docs: Update some post`, a deployment co
commit_message: ${{ github.event.head_commit.message }}
```
To set a full custom commit message without a triggered commit hash,
use the `full_commit_message` option instead of the `commit_message` option.
```yaml
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
full_commit_message: ${{ github.event.head_commit.message }}
```
### ⭐️ Create Git tag
Here is an example workflow.
@@ -455,7 +496,7 @@ Next, Go to **Repository Settings**
### ⭐️ First Deployment with `GITHUB_TOKEN`
The `GITHUB_TOKEN` has limitations for the first deployment so we have to select the GitHub Pages branch on the repository settings tab.
The `GITHUB_TOKEN` has limitations for the first deployment so we have to select the GitHub Pages branch on the repository settings tab. After that, do the second deployment like the following pictures.
| First deployment failed | Go to the settings tab |
|---|---|
@@ -482,7 +523,7 @@ It is useful to watch this repository (release only) to check the [latest releas
### ⭐️ Static Site Generators with Node.js
[hexo], [gitbook], [vuepress], [react-static], [gridsome], etc.
[hexo], [gitbook], [vuepress], [react-static], [gridsome], and so on.
[hexo]: https://github.com/hexojs/hexo
[gitbook]: https://github.com/GitbookIO/gitbook
@@ -680,16 +721,24 @@ An example workflow for [Docusaurus](https://docusaurus.io/).
`npx @docusaurus/init@next init website classic` is useful to create a new Docusaurus project.
```yaml
# .github/workflows/deploy.yml
name: github pages
on:
push:
branches:
- master
paths:
- '.github/workflows/deploy.yml'
- 'website/**'
jobs:
deploy:
runs-on: ubuntu-18.04
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v2
@@ -706,14 +755,12 @@ jobs:
uses: actions/cache@v1
with:
path: ${{ steps.yarn-cache.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
key: ${{ runner.os }}-website-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
${{ runner.os }}-website-
- run: yarn install
working-directory: ./website
- run: yarn build
working-directory: ./website
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
@@ -724,7 +771,7 @@ jobs:
### ⭐️ Static Site Generators with Python
[pelican], [MkDocs], [sphinx], etc.
[pelican], [MkDocs], [sphinx], and so on.
[pelican]: https://github.com/getpelican/pelican
[MkDocs]: https://github.com/mkdocs/mkdocs
@@ -747,23 +794,29 @@ jobs:
- uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v1
uses: actions/setup-python@v2
with:
python-version: '3.6'
architecture: 'x64'
python-version: '3.8'
- name: Upgrade pip
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip
- name: Get pip cache dir
id: pip-cache
run: echo "::set-output name=dir::$(pip cache dir)"
- name: Cache dependencies
uses: actions/cache@v1
with:
path: ~/.cache/pip
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r ./requirements.txt
run: python3 -m pip install -r ./requirements.txt
- run: mkdocs build
@@ -964,6 +1017,10 @@ jobs:
publish_dir: ./Output
```
<div align="right">
<a href="#table-of-contents">Back to TOC ☝️</a>
</div>
## License

View File

@@ -51,6 +51,7 @@ function getInputsLog(authMethod: string, inps: Inputs): string {
[INFO] UserName: ${inps.UserName}
[INFO] UserEmail: ${inps.UserEmail}
[INFO] CommitMessage: ${inps.CommitMessage}
[INFO] FullCommitMessage: ${inps.FullCommitMessage}
[INFO] TagName: ${inps.TagName}
[INFO] TagMessage: ${inps.TagMessage}
[INFO] EnableJekyll (DisableNoJekyll): ${inps.DisableNoJekyll}
@@ -117,6 +118,7 @@ describe('getInputs()', () => {
expect(inps.UserName).toMatch('');
expect(inps.UserEmail).toMatch('');
expect(inps.CommitMessage).toMatch('');
expect(inps.FullCommitMessage).toMatch('');
expect(inps.TagName).toMatch('');
expect(inps.TagMessage).toMatch('');
expect(inps.DisableNoJekyll).toBe(false);
@@ -136,6 +138,7 @@ describe('getInputs()', () => {
process.env['INPUT_USER_NAME'] = 'username';
process.env['INPUT_USER_EMAIL'] = 'github@github.com';
process.env['INPUT_COMMIT_MESSAGE'] = 'feat: Add new feature';
process.env['INPUT_FULL_COMMIT_MESSAGE'] = 'feat: Add new feature';
process.env['INPUT_TAG_NAME'] = 'deploy-v1.2.3';
process.env['INPUT_TAG_MESSAGE'] = 'Deployment v1.2.3';
process.env['INPUT_DISABLE_NOJEKYLL'] = 'true';
@@ -155,12 +158,19 @@ describe('getInputs()', () => {
expect(inps.UserName).toMatch('username');
expect(inps.UserEmail).toMatch('github@github.com');
expect(inps.CommitMessage).toMatch('feat: Add new feature');
expect(inps.FullCommitMessage).toMatch('feat: Add new feature');
expect(inps.TagName).toMatch('deploy-v1.2.3');
expect(inps.TagMessage).toMatch('Deployment v1.2.3');
expect(inps.DisableNoJekyll).toBe(true);
expect(inps.CNAME).toMatch('github.com');
});
test('get spec inputs enable_jekyll', () => {
process.env['INPUT_ENABLE_JEKYLL'] = 'true';
const inps: Inputs = getInputs();
expect(inps.DisableNoJekyll).toBe(true);
});
test('throw error enable_jekyll or disable_nojekyll', () => {
process.env['INPUT_DEPLOY_KEY'] = 'test_deploy_key';
process.env['INPUT_ENABLE_JEKYLL'] = 'true';

View File

@@ -1,4 +1,9 @@
import {getUserName, getUserEmail, setCommitAuthor} from '../src/git-utils';
import {
getUserName,
getUserEmail,
setCommitAuthor,
getCommitMessage
} from '../src/git-utils';
import {getWorkDirName, createWorkDir} from '../src/utils';
import {CmdResult} from '../src/interfaces';
import * as exec from '@actions/exec';
@@ -114,3 +119,54 @@ describe('setCommitAuthor()', () => {
);
});
});
describe('getCommitMessage()', () => {
test('get default message', () => {
const test = getCommitMessage('', '', '', 'actions/pages', 'commit_hash');
expect(test).toMatch('deploy: commit_hash');
});
test('get default message for external repository', () => {
const test = getCommitMessage(
'',
'',
'actions/actions.github.io',
'actions/pages',
'commit_hash'
);
expect(test).toMatch('deploy: actions/pages@commit_hash');
});
test('get custom message', () => {
const test = getCommitMessage(
'Custom msg',
'',
'',
'actions/pages',
'commit_hash'
);
expect(test).toMatch('Custom msg commit_hash');
});
test('get custom message for external repository', () => {
const test = getCommitMessage(
'Custom msg',
'',
'actions/actions.github.io',
'actions/pages',
'commit_hash'
);
expect(test).toMatch('Custom msg actions/pages@commit_hash');
});
test('get full custom message', () => {
const test = getCommitMessage(
'',
'Full custom msg',
'',
'actions/pages',
'commit_hash'
);
expect(test).toMatch('Full custom msg');
});
});

View File

@@ -47,7 +47,10 @@ inputs:
description: 'Set Git user.email'
required: false
commit_message:
description: 'Set custom commit message'
description: 'Set a custom commit message with a triggered commit hash'
required: false
full_commit_message:
description: 'Set a custom full commit message without a triggered commit hash'
required: false
tag_name:
description: 'Set tag name'

File diff suppressed because one or more lines are too long

2875
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,10 +1,10 @@
{
"name": "actions-github-pages",
"version": "3.5.7",
"version": "3.6.0",
"description": "GitHub Actions for GitHub Pages",
"main": "lib/index.js",
"engines": {
"node": ">=12.16.2",
"node": ">=12.16.3",
"npm": ">=6.14.4"
},
"scripts": {
@@ -30,6 +30,9 @@
"src/**/*.ts": [
"prettier --check",
"eslint"
],
"README.md": [
"npx doctoc@1.4.0 --github"
]
},
"repository": {
@@ -51,8 +54,8 @@
},
"homepage": "https://github.com/peaceiris/actions-gh-pages#readme",
"dependencies": {
"@actions/core": "^1.2.3",
"@actions/exec": "^1.0.3",
"@actions/core": "^1.2.4",
"@actions/exec": "^1.0.4",
"@actions/github": "^2.1.1",
"@actions/io": "^1.0.2"
},
@@ -60,19 +63,19 @@
"@types/jest": "^25.2.1",
"@types/js-yaml": "^3.12.3",
"@types/node": "~12",
"@typescript-eslint/eslint-plugin": "^2.28.0",
"@typescript-eslint/parser": "^2.28.0",
"@typescript-eslint/eslint-plugin": "^2.30.0",
"@typescript-eslint/parser": "^2.30.0",
"@zeit/ncc": "^0.22.1",
"eslint": "^6.8.0",
"eslint-plugin-jest": "^23.8.2",
"husky": "^4.2.5",
"jest": "^25.3.0",
"jest-circus": "^25.3.0",
"jest": "^25.5.4",
"jest-circus": "^25.5.4",
"js-yaml": "^3.13.1",
"lint-staged": "^10.1.3",
"prettier": "2.0.4",
"lint-staged": "^10.2.2",
"prettier": "2.0.5",
"standard-version": "^7.1.0",
"ts-jest": "^25.3.1",
"ts-jest": "^25.4.0",
"typescript": "^3.8.3"
}
}

View File

@@ -22,6 +22,7 @@ export function showInputs(inps: Inputs): void {
[INFO] UserName: ${inps.UserName}
[INFO] UserEmail: ${inps.UserEmail}
[INFO] CommitMessage: ${inps.CommitMessage}
[INFO] FullCommitMessage: ${inps.FullCommitMessage}
[INFO] TagName: ${inps.TagName}
[INFO] TagMessage: ${inps.TagMessage}
[INFO] EnableJekyll (DisableNoJekyll): ${inps.DisableNoJekyll}
@@ -61,6 +62,7 @@ export function getInputs(): Inputs {
UserName: core.getInput('user_name'),
UserEmail: core.getInput('user_email'),
CommitMessage: core.getInput('commit_message'),
FullCommitMessage: core.getInput('full_commit_message'),
TagName: core.getInput('tag_name'),
TagMessage: core.getInput('tag_message'),
DisableNoJekyll: useBuiltinJekyll,

View File

@@ -1,6 +1,5 @@
import * as core from '@actions/core';
import * as exec from '@actions/exec';
import * as github from '@actions/github';
import * as io from '@actions/io';
import path from 'path';
import fs from 'fs';
@@ -133,26 +132,38 @@ export async function setCommitAuthor(
await exec.exec('git', ['config', 'user.email', getUserEmail(userEmail)]);
}
export function getCommitMessage(
msg: string,
fullMsg: string,
extRepo: string,
baseRepo: string,
hash: string
): string {
const msgHash = ((): string => {
if (extRepo) {
return `${baseRepo}@${hash}`;
} else {
return hash;
}
})();
const subject = ((): string => {
if (fullMsg) {
return fullMsg;
} else if (msg) {
return `${msg} ${msgHash}`;
} else {
return `deploy: ${msgHash}`;
}
})();
return subject;
}
export async function commit(
allowEmptyCommit: boolean,
externalRepository: string,
message: string
msg: string
): Promise<void> {
let msg = '';
if (message) {
msg = message;
} else {
msg = 'deploy:';
}
const hash = `${process.env.GITHUB_SHA}`;
const baseRepo = `${github.context.repo.owner}/${github.context.repo.repo}`;
if (externalRepository) {
msg = `${msg} ${baseRepo}@${hash}`;
} else {
msg = `${msg} ${hash}`;
}
try {
if (allowEmptyCommit) {
await exec.exec('git', ['commit', '--allow-empty', '-m', `${msg}`]);

View File

@@ -11,6 +11,7 @@ export interface Inputs {
readonly UserName: string;
readonly UserEmail: string;
readonly CommitMessage: string;
readonly FullCommitMessage: string;
readonly TagName: string;
readonly TagMessage: string;
readonly DisableNoJekyll: boolean;

View File

@@ -1,10 +1,18 @@
import {context} from '@actions/github';
import * as core from '@actions/core';
import * as exec from '@actions/exec';
import * as github from '@actions/github';
import {Inputs} from './interfaces';
import {showInputs, getInputs} from './get-inputs';
import {setTokens} from './set-tokens';
import {setRepo, setCommitAuthor, commit, push, pushTag} from './git-utils';
import {
setRepo,
setCommitAuthor,
getCommitMessage,
commit,
push,
pushTag
} from './git-utils';
import {getWorkDirName, addNoJekyll, addCNAME, skipOnFork} from './utils';
export async function run(): Promise<void> {
@@ -54,11 +62,16 @@ export async function run(): Promise<void> {
await exec.exec('git', ['remote', 'add', 'origin', remoteURL]);
await exec.exec('git', ['add', '--all']);
await setCommitAuthor(inps.UserName, inps.UserEmail);
await commit(
inps.AllowEmptyCommit,
const hash = `${process.env.GITHUB_SHA}`;
const baseRepo = `${github.context.repo.owner}/${github.context.repo.repo}`;
const commitMessage = getCommitMessage(
inps.CommitMessage,
inps.FullCommitMessage,
inps.ExternalRepository,
inps.CommitMessage
baseRepo,
hash
);
await commit(inps.AllowEmptyCommit, commitMessage);
await push(inps.PublishBranch, inps.ForceOrphan);
await pushTag(inps.TagName, inps.TagMessage);