update docs links
This commit is contained in:
Родитель
bfbd5851c9
Коммит
922d07f90a
|
@ -283,7 +283,7 @@ As seen above, we have two steps. One for a noop deploy, and one for a regular d
|
|||
| `deploy_message_path` | `false` | `".github/deployment_message.md"` | The path to a markdown file which is used as a template for custom deployment messages. Example: `".github/deployment_message.md"` |
|
||||
| `sticky_locks` | `false` | `"false"` | If set to `"true"`, locks will not be released after a deployment run completes. This applies to both successful, and failed deployments.Sticky locks are also known as ["hubot style deployment locks"](./docs/hubot-style-deployment-locks.md). They will persist until they are manually released by a user, or if you configure [another workflow with the "unlock on merge" mode](./docs/unlock-on-merge.md) to remove them automatically on PR merge. |
|
||||
| `sticky_locks_for_noop` | `false` | `"false"` | If set to `"true"`, then sticky_locks will also be used for noop deployments. This can be useful in some cases but it often leads to locks being left behind when users test noop deployments. |
|
||||
| `allow_sha_deployments` | `false` | `"false"` | If set to `"true"`, then you can deploy a specific sha instead of a branch. Example: `".deploy 1234567890abcdef1234567890abcdef12345678 to production"` - This is dangerous and potentially unsafe, [view the docs](https://github.com/github/branch-deploy/issues/213) to learn more |
|
||||
| `allow_sha_deployments` | `false` | `"false"` | If set to `"true"`, then you can deploy a specific sha instead of a branch. Example: `".deploy 1234567890abcdef1234567890abcdef12345678 to production"` - This is dangerous and potentially unsafe, [view the docs](docs/sha-deployments.md) to learn more |
|
||||
|
||||
## Outputs 📤
|
||||
|
||||
|
|
|
@ -1520,7 +1520,7 @@ test('runs prechecks when an exact sha is set, and the sha deployment feature is
|
|||
)
|
||||
|
||||
expect(warningMock).toHaveBeenCalledWith(
|
||||
`⚠️ sha deployments are ${COLORS.warning}unsafe${COLORS.reset} as they bypass all checks - read more here: https://github.com/github/branch-deploy/issues/213`
|
||||
`⚠️ sha deployments are ${COLORS.warning}unsafe${COLORS.reset} as they bypass all checks - read more here: https://github.com/github/branch-deploy/blob/main/docs/sha-deployments.md`
|
||||
)
|
||||
|
||||
expect(setOutputMock).toHaveBeenCalledWith(
|
||||
|
|
|
@ -134,7 +134,7 @@ inputs:
|
|||
required: false
|
||||
default: "false"
|
||||
allow_sha_deployments:
|
||||
description: 'If set to "true", then you can deploy a specific sha instead of a branch. Example: ".deploy 1234567890abcdef1234567890abcdef12345678 to production" - This is dangerous and potentially unsafe, view the docs to learn more: https://github.com/github/branch-deploy/issues/213'
|
||||
description: 'If set to "true", then you can deploy a specific sha instead of a branch. Example: ".deploy 1234567890abcdef1234567890abcdef12345678 to production" - This is dangerous and potentially unsafe, view the docs to learn more: https://github.com/github/branch-deploy/blob/main/docs/sha-deployments.md'
|
||||
required: false
|
||||
default: "false"
|
||||
outputs:
|
||||
|
|
|
@ -20311,7 +20311,7 @@ async function prechecks(context, octokit, data) {
|
|||
// ... passed any CI checks or has been reviewed. Additionally, the user could be deploying a sha from a forked repo...
|
||||
// ... which could contain malicious code or a sha that has not been reviewed or tested from another user's branch...
|
||||
// ... this style of deployment is not recommended and should only be used in very specific situations. Read more here:
|
||||
// https://github.com/github/branch-deploy/issues/213
|
||||
// https://github.com/github/branch-deploy/blob/main/docs/sha-deployments.md
|
||||
} else if (
|
||||
data.inputs.allow_sha_deployments === true &&
|
||||
data.environmentObj.sha !== null
|
||||
|
@ -20319,7 +20319,7 @@ async function prechecks(context, octokit, data) {
|
|||
message = `✅ deployment requested using an exact ${COLORS.highlight}sha${COLORS.reset}`
|
||||
core.info(message)
|
||||
core.warning(
|
||||
`⚠️ sha deployments are ${COLORS.warning}unsafe${COLORS.reset} as they bypass all checks - read more here: https://github.com/github/branch-deploy/issues/213`
|
||||
`⚠️ sha deployments are ${COLORS.warning}unsafe${COLORS.reset} as they bypass all checks - read more here: https://github.com/github/branch-deploy/blob/main/docs/sha-deployments.md`
|
||||
)
|
||||
core.debug(`an exact sha was used, using sha instead of ref`)
|
||||
// since an exact sha was used, we overwrite both the ref and sha values with the exact sha that was provided by the user
|
||||
|
|
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
@ -269,7 +269,7 @@ export async function prechecks(context, octokit, data) {
|
|||
// ... passed any CI checks or has been reviewed. Additionally, the user could be deploying a sha from a forked repo...
|
||||
// ... which could contain malicious code or a sha that has not been reviewed or tested from another user's branch...
|
||||
// ... this style of deployment is not recommended and should only be used in very specific situations. Read more here:
|
||||
// https://github.com/github/branch-deploy/issues/213
|
||||
// https://github.com/github/branch-deploy/blob/main/docs/sha-deployments.md
|
||||
} else if (
|
||||
data.inputs.allow_sha_deployments === true &&
|
||||
data.environmentObj.sha !== null
|
||||
|
@ -277,7 +277,7 @@ export async function prechecks(context, octokit, data) {
|
|||
message = `✅ deployment requested using an exact ${COLORS.highlight}sha${COLORS.reset}`
|
||||
core.info(message)
|
||||
core.warning(
|
||||
`⚠️ sha deployments are ${COLORS.warning}unsafe${COLORS.reset} as they bypass all checks - read more here: https://github.com/github/branch-deploy/issues/213`
|
||||
`⚠️ sha deployments are ${COLORS.warning}unsafe${COLORS.reset} as they bypass all checks - read more here: https://github.com/github/branch-deploy/blob/main/docs/sha-deployments.md`
|
||||
)
|
||||
core.debug(`an exact sha was used, using sha instead of ref`)
|
||||
// since an exact sha was used, we overwrite both the ref and sha values with the exact sha that was provided by the user
|
||||
|
|
Загрузка…
Ссылка в новой задаче