adk23333/github-pages-deploy-action
1
0
Fork 0
mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
James Ives 2020-03-08 19:33:31 -04:00 committed by GitHub
parent 219ed21338
commit 1dd704840e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -129,7 +129,7 @@ Once you've generated the key pair you must add the contents of the public key w
With this configured you must add the `ssh-agent` step to your workflow and set `SSH` to `true` within the deploy action. With this configured you must add the `ssh-agent` step to your workflow and set `SSH` to `true` within the deploy action.
```yml ```yml
- name: Install SSH Client - name: Install SSH Client 🔑
uses: webfactory/ssh-agent@v0.2.0 uses: webfactory/ssh-agent@v0.2.0
with: with:
ssh-private-key: ${{ secrets.DEPLOY_KEY }} ssh-private-key: ${{ secrets.DEPLOY_KEY }}
@ -160,7 +160,7 @@ jobs:
with: with:
persist-credentials: false persist-credentials: false
- name: Install - name: Install 🔧
run: | run: |
npm install npm install
npm run-script build npm run-script build
@ -212,12 +212,12 @@ jobs:
with: with:
persist-credentials: false persist-credentials: false
- name: Install # The project is built using npm and placed in the 'build' folder. - name: Install 🔧 # The project is built using npm and placed in the 'build' folder.
run: | run: |
npm install npm install
npm run-script build npm run-script build
- name: Upload Artifacts # The project is then uploaded as an artifact named 'site'. - name: Upload Artifacts 🔺 # The project is then uploaded as an artifact named 'site'.
uses: actions/upload-artifact@v1 uses: actions/upload-artifact@v1
with: with:
name: site name: site
@ -232,7 +232,7 @@ jobs:
with: with:
persist-credentials: false persist-credentials: false
- name: Download Artifacts # The built project is downloaded into the 'site' folder. - name: Download Artifacts 🔻 # The built project is downloaded into the 'site' folder.
uses: actions/download-artifact@v1 uses: actions/download-artifact@v1
with: with:
name: site name: site
@ -255,11 +255,11 @@ jobs:
If you use a [container](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainer) in your workflow you may need to run an additional step to install `rsync` as this action depends on it. You can view an example of this below. If you use a [container](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainer) in your workflow you may need to run an additional step to install `rsync` as this action depends on it. You can view an example of this below.
```yml ```yml
- name: Install rsync - name: Install rsync 📚
run: | run: |
apt-get update && apt-get install -y rsync apt-get update && apt-get install -y rsync
- name: Deploy - name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@releases/v3 uses: JamesIves/github-pages-deploy-action@releases/v3
``` ```