From c284911fe17a5e719089f29411dceb772a857d85 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Thu, 7 Dec 2023 16:08:41 +0530 Subject: [PATCH] chore/docs: update version, fix typos Signed-off-by: K.B.Dharun Krishna --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c58ce9f0..4a10ad48 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ jobs: steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action + uses: actions/deploy-pages@v3 # or specific "vX.X.X" version tag for this action ``` ### Inputs 📥 @@ -51,7 +51,7 @@ jobs: | `token` | `true` | `${{ github.token }}` | The GitHub token used to create an authenticated client - Provided for you by default! | | `timeout` | `false` | `"600000"` | Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes) | | `error_count` | `false` | `"10"` | Maximum number of status report errors before cancelling a deployment (default: 10) | -| `reporting_interval` | `false` | `"5000"` | Time in milliseconds between two deployment status report (default: 5 seconds) | +| `reporting_interval` | `false` | `"5000"` | Time in milliseconds between two deployment status reports (default: 5 seconds) | | `artifact_name` | `false` | `"github-pages"` | The name of the artifact to deploy | | `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!) | @@ -85,7 +85,7 @@ There are a few important considerations to be aware of: ## Compatibility -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. +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. | Release | GHES Compatibility | |:---|:---| @@ -107,7 +107,7 @@ In order to release a new version of this Action: 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: -3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v1`. +3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding major version tag such as `v1`. ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].