Skip to content

Commit c284911

Browse files
committed
chore/docs: update version, fix typos
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
1 parent ae44070 commit c284911

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
steps:
4242
- name: Deploy to GitHub Pages
4343
id: deployment
44-
uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action
44+
uses: actions/deploy-pages@v3 # or specific "vX.X.X" version tag for this action
4545
```
4646
4747
### Inputs 📥
@@ -51,7 +51,7 @@ jobs:
5151
| `token` | `true` | `${{ github.token }}` | The GitHub token used to create an authenticated client - Provided for you by default! |
5252
| `timeout` | `false` | `"600000"` | Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes) |
5353
| `error_count` | `false` | `"10"` | Maximum number of status report errors before cancelling a deployment (default: 10) |
54-
| `reporting_interval` | `false` | `"5000"` | Time in milliseconds between two deployment status report (default: 5 seconds) |
54+
| `reporting_interval` | `false` | `"5000"` | Time in milliseconds between two deployment status reports (default: 5 seconds) |
5555
| `artifact_name` | `false` | `"github-pages"` | The name of the artifact to deploy |
5656
| `preview` | `false` | `"false"` | Is this attempting to deploy a pull request as a GitHub Pages preview site? (NOTE: This feature is only in alpha currently and is not available to the public!) |
5757

@@ -85,7 +85,7 @@ There are a few important considerations to be aware of:
8585

8686
## Compatibility
8787

88-
This action is primarily design for use with GitHub.com's Actions workflows and Pages deployments. However, certain releases should also be compatible with GitHub Enterprise Server (GHES) `3.7` and above.
88+
This action is primarily designed for use with GitHub.com's Actions workflows and Pages deployments. However, certain releases should also be compatible with GitHub Enterprise Server (GHES) `3.7` and above.
8989

9090
| Release | GHES Compatibility |
9191
|:---|:---|
@@ -107,7 +107,7 @@ In order to release a new version of this Action:
107107

108108
2. Publish the draft release from the `main` branch with semantic version as the tag name, _with_ the checkbox to publish to the GitHub Marketplace checked. :ballot_box_with_check:
109109

110-
3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v1`.
110+
3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding major version tag such as `v1`.
111111

112112
⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
113113

0 commit comments

Comments
 (0)