8000 Update README.md · lyrl/github-pages-deploy-action@3a9b795 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3a9b795

Browse files
JamesIvesJamesIves
committed
Update README.md
1 parent 7fe0750 commit 3a9b795

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,12 @@ The following options must be configured in order to make a deployment.
125125
| `branch` | This is the branch you wish to deploy to, for example `gh-pages` or `docs`. | `with` | **Yes** |
126126
| `folder` | The folder in your repository that you want to deploy. If your build script compiles into a directory named `build` you'd put it here. If you wish to deploy the root directory you can place a `.` here. You can also utilize absolute file paths by appending `~` to your folder path. | `with` | **Yes** |
127127

128-
By default the action does not need any token configuration and uses the provided repository scoped GitHub token to make the deployment. If you require most customization you can modify the deployment type using the following options.
128+
By default the action does not need any token configuration and uses the provided repository scoped GitHub token to make the deployment. If you require more customization you can modify the deployment type using the following options.
129129

130130
| Key | Value Information | Type | Required |
131131
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -------- |
132132
| `token` | This option defaults to the repository scoped GitHub Token. However if you need more permissions for things such as deploying to another repository, you can add a Personal Access Token (PAT) here. This should be stored in the `secrets / with` menu **as a secret**. We reccomend using a service account with the least permissions neccersary and recommend when generating a new PAT that you select the least permission scopes neccersary. [Learn more about creating and using encrypted secrets here.](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | `with` | **No** |
133-
| `ssh-key` | You can configure the action to deploy using SSH by setting this option to a private SSH key stored **as a secret**. It can also 8000 be set to `true` to use an existing SSH client configuration. For more detailed information on how to add your ssh key pair please refer to the [Using a Deploy Key section of this README](https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-). | `with` | **No** |
133+
| `ssh-key` | You can configure the action to deploy using SSH by setting this option to a private SSH key stored **as a secret**. It can also be set to `true` to use an existing SSH client configuration. For more detailed information on how to add your public/private ssh key pair please refer to the [Using a Deploy Key section of this README](https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-). | `with` | **No** |
134134

135135
#### Optional Choices
136136

@@ -199,7 +199,7 @@ jobs:
199199
runs-on: ubuntu-latest
200200
steps:
201201
- name: Checkout 🛎️
202-
uses: actions/checkout@v2
202+
uses: actions/checkout@v2.3.1
203203

204204
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
205205
run: |
@@ -248,7 +248,7 @@ jobs:
248248
runs-on: windows-latest # The first job utilizes windows-latest
249249
steps:
250250
- name: Checkout 🛎️
251-
uses: actions/checkout@v2
251+
uses: actions/checkout@v2.3.1
252252
253253
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
254254
run: |
@@ -266,7 +266,7 @@ jobs:
266266
runs-on: ubuntu-latest
267267
steps:
268268
- name: Checkout 🛎️
269-
uses: actions/checkout@v2
269+
uses: actions/checkout@v2.3.1
270270
271271
- name: Download Artifacts 🔻 # The built project is downloaded into the 'site' folder.
272272
uses: actions/download-artifact@v1
@@ -320,7 +320,7 @@ jobs:
320320
runs-on: ubuntu-latest
321321
steps:
322322
- name: Checkout 🛎️
323-
uses: actions/checkout@v2
323+
uses: actions/checkout@v2.3.1
324324
325325
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
326326
run: |
@@ -346,6 +346,6 @@ If you wish to remove these files you must go into the deployment branch directl
346346

347347
## Support 💖
348348

349-
This project would not be possible without all of our fantastic [contributors](https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors).
349+
This project would not be possible without all of our fantastic [contributors](https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors). The project logo was created by [Paganini](https://twitter.com/paganiniart).
350350

351351
If you'd like to support the maintenance and upkeep of this project you can [donate via GitHub Sponsors](https://github.com/sponsors/JamesIves). This project is distributed under the [MIT](https://github.com/JamesIves/github-pages-deploy-action/blob/dev/LICENSE) license.

0 commit comments

Comments
 (0)
0