8000 Update README.md · lyrl/github-pages-deploy-action@7644ba3 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7644ba3

Browse files
authored
Update README.md
1 parent bc82101 commit 7644ba3

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
@@ -1,6 +1,6 @@
11
<p align="center">
22
<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">
44
</a>
55
</p>
66

@@ -10,23 +10,23 @@
1010

1111
<p align="center">
1212
<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">
1414
</a>
1515

1616
<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">
1818
</a>
1919

2020
<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">
2222
</a>
2323

2424
<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">
2626
</a>
2727

2828
<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=">
3030
</a>
3131
</p>
3232

@@ -131,7 +131,7 @@ By default the action does not need any token configuration and uses the provide
131131

132132
| Key | Value Information | Type | Required |
133133
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -------- |
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** |
135135
| `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** |
136136

137137
#### Optional Choices

0 commit comments

Comments
 (0)
0