From 55fea0d3a332a4713db22480d70b53bc08467166 Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Tue, 3 Jan 2023 00:58:28 -0800 Subject: [PATCH] Unify language in the REST API for deployments (#33690) Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> Co-authored-by: Vanessa --- content/rest/deployments/branch-policies.md | 6 +++--- content/rest/deployments/deployments.md | 4 ++-- content/rest/deployments/environments.md | 4 ++-- content/rest/deployments/index.md | 2 +- content/rest/deployments/statuses.md | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/rest/deployments/branch-policies.md b/content/rest/deployments/branch-policies.md index b198c4a034..6137807af1 100644 --- a/content/rest/deployments/branch-policies.md +++ b/content/rest/deployments/branch-policies.md @@ -2,7 +2,7 @@ title: Deployment branch policies allowTitleToDifferFromFilename: true shortTitle: Deployment branch policies -intro: The Deployment branch policies API allows you to manage custom deployment branch policies. +intro: Use the REST API to manage custom deployment branch policies. versions: fpt: '*' ghes: '*' @@ -13,8 +13,8 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Deployment branch policies API +## About deployment branch policies -The Deployment branch policies API allows you to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see "[Create or update an environment](/rest/deployments/environments#create-or-update-an-environment)." +You can use the REST API to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see "[Create or update an environment](/rest/deployments/environments#create-or-update-an-environment)." For more information about restricting environment deployments to certain branches, see "[Using environments for deployment](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)." diff --git a/content/rest/deployments/deployments.md b/content/rest/deployments/deployments.md index 0cd2b42859..89b72e09d4 100644 --- a/content/rest/deployments/deployments.md +++ b/content/rest/deployments/deployments.md @@ -1,6 +1,6 @@ --- title: Deployments -intro: The Deployments API allows you to create and delete deployments and deployment environments. +intro: Use the REST API to create and delete deployments and deployment environments. versions: fpt: '*' ghes: '*' @@ -11,7 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the deployments API +## About deployments Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). diff --git a/content/rest/deployments/environments.md b/content/rest/deployments/environments.md index efb8310135..4006351694 100644 --- a/content/rest/deployments/environments.md +++ b/content/rest/deployments/environments.md @@ -2,7 +2,7 @@ title: Deployment environments allowTitleToDifferFromFilename: true shortTitle: Environments -intro: 'The Deployment environments API allows you to create, configure, and delete deployment environments.' +intro: 'Use the REST API to create, configure, and delete deployment environments.' versions: fpt: '*' ghes: '*' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Deployment environments API +## About deployment environments For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." diff --git a/content/rest/deployments/index.md b/content/rest/deployments/index.md index 07907c10d1..640346a850 100644 --- a/content/rest/deployments/index.md +++ b/content/rest/deployments/index.md @@ -1,6 +1,6 @@ --- title: Deployments -intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' +intro: 'Use the REST API to create and delete deploy keys, deployments, and deployment environments.' allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/content/rest/deployments/statuses.md b/content/rest/deployments/statuses.md index 02ae99768d..a8c6ea443d 100644 --- a/content/rest/deployments/statuses.md +++ b/content/rest/deployments/statuses.md @@ -1,6 +1,6 @@ --- title: Deployment statuses -intro: '' +intro: 'Use the REST API to manage deployment statuses.' versions: fpt: '*' ghes: '*'