|
1 | 1 | <p align="center">
|
2 | 2 | <a href="https://github.com/marketplace/actions/deploy-to-github-pages">
|
3 |
| - <img width="300px" src="https://github.com/JamesIves/github-pages-deploy-action/raw/dev-v4/.github/logo.png"> |
| 3 | + <img alt="" width="300px" src="https://github.com/JamesIves/github-pages-deploy-action/raw/dev-v4/.github/logo.png"> |
4 | 4 | </a>
|
5 | 5 | </p>
|
6 | 6 |
|
|
10 | 10 |
|
11 | 11 | <p align="center">
|
12 | 12 | <a href="https://github.com/JamesIves/github-pages-deploy-action/actions">
|
13 |
| - <img src="https://github.com/JamesIves/github-pages-deploy-action/workflows/unit-tests/badge.svg"> |
| 13 | + <img src="https://github.com/JamesIves/github-pages-deploy-action/workflows/unit-tests/badge.svg" alt="Unit test status badge"> |
14 | 14 | </a>
|
15 | 15 |
|
16 | 16 | <a href="https://github.com/JamesIves/github-pages-deploy-action/actions">
|
17 |
| - <img src="https://github.com/JamesIves/github-pages-deploy-action/workflows/integration-tests/badge.svg"> |
| 17 | + <img src="https://github.com/JamesIves/github-pages-deploy-action/workflows/integration-tests/badge.svg" alt="Integration test status badge"> |
18 | 18 | </a>
|
19 | 19 |
|
20 | 20 | <a href="https://codecov.io/gh/JamesIves/github-pages-deploy-action/branch/dev">
|
21 |
| - <img src="https://codecov.io/gh/JamesIves/github-pages-deploy-action/branch/dev/graph/badge.svg"> |
| 21 | + <img src="https://codecov.io/gh/JamesIves/github-pages-deploy-action/branch/dev/graph/badge.svg" alt="Code coverage status badge"> |
22 | 22 | </a>
|
23 | 23 |
|
24 | 24 | <a href="https://github.com/JamesIves/github-pages-deploy-action/releases">
|
25 |
| - <img src="https://img.shields.io/github/v/release/JamesIves/github-pages-deploy-action.svg?logo=github"> |
| 25 | + <img src="https://img.shields.io/github/v/release/JamesIves/github-pages-deploy-action.svg?logo=github" alt="Release version badge"> |
26 | 26 | </a>
|
27 | 27 |
|
28 | 28 | <a href="https://github.com/marketplace/actions/deploy-to-github-pages">
|
29 |
| - <img src="https://img.shields.io/badge/action-marketplace-blue.svg?logo=github&color=orange"> |
| 29 | + <img src="https://img.shields.io/badge/action-marketplace-blue.svg?logo=github&color=orange" alt="> |
30 | 30 | </a>
|
31 | 31 | </p>
|
32 | 32 |
|
@@ -131,7 +131,7 @@ By default the action does not need any token configuration and uses the provide
|
131 | 131 |
|
132 | 132 | | Key | Value Information | Type | Required |
|
133 | 133 | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -------- |
|
134 |
| -| `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) | **No** | |
| 134 | +| `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** | |
135 | 135 | | `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 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** |
|
136 | 136 |
|
137 | 137 | #### Optional Choices
|
|
0 commit comments