AWS devopsagent documentation change
Summary
Clarified GitHub organization registration steps and added notes about authorization requirements. Enhanced instructions for app installation flow and permission handling.
Security assessment
Changes focus on process clarification (exact name matching, authorization flow) without addressing vulnerabilities. No security weaknesses or incidents are mentioned. The added notes emphasize correct setup procedures but don't introduce security features.
Diff
diff --git a/devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md b/devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md index 5e76ba5db..fbb1ce704 100644 --- a//devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md +++ b//devopsagent/latest/userguide/connecting-to-cicd-pipelines-connecting-github.md @@ -66 +66 @@ On the "Register GitHub Account / Organization" screen, select whether you're co - * **Organization** – A shared GitHub account where multiple people can collaborate across many projects at once + * **Organization** – A shared GitHub account where multiple people can collaborate across many projects at once. If you select **Organization** , enter the GitHub organization name. The name must match your GitHub organization name exactly, because you must authorize and install the app on that organization in the following steps. @@ -94 +94 @@ Choose **Submit** to begin the app setup process. The next steps differ dependin - 1. You'll be redirected to GitHub to install the AWS DevOps Agent GitHub app. + 1. GitHub redirects you to sign in and authorize AWS DevOps Agent. @@ -96 +96 @@ Choose **Submit** to begin the app setup process. The next steps differ dependin - 2. Select which account or organization to install the app in. + 2. Review the authorization request and authorize AWS DevOps Agent. @@ -98 +98 @@ Choose **Submit** to begin the app setup process. The next steps differ dependin - 3. The app allows AWS DevOps Agent to receive events from connected repositories, including deployment events. + 3. After you authorize, AWS DevOps Agent completes the registration. If the GitHub App is not yet installed on the account or organization you specified, you continue to the installation page (see Step 4). If the app is already installed, registration completes without reinstalling it. @@ -99,0 +100 @@ Choose **Submit** to begin the app setup process. The next steps differ dependin + 4. After installation, AWS DevOps Agent receives events from your connected repositories, including deployment events. @@ -102,0 +104,9 @@ Choose **Submit** to begin the app setup process. The next steps differ dependin + +###### Note + + __You must authorize and install the app on the same User or Organization you specified during registration. If you authorize or install on a different account or organization, registration fails and you must restart the process, selecting the correct account or organization. + +###### Note + + __AWS DevOps Agent uses a separate GitHub App for each permission level (Read & Write and Read Only), and each app is authorized independently. GitHub remembers an authorization until you revoke it under Settings > Applications > Authorized GitHub Apps. If you previously authorized the app at this permission level, GitHub might skip the authorization screen. If you change the permission level, GitHub prompts you to authorize the corresponding app the first time. + @@ -118 +128,3 @@ GitHub Enterprise Server uses a GitHub App Manifest flow, which automatically se - 1. You'll see the **Install & Authorize** page for the GitHub App. +Skip this step if the GitHub App is already installed on your account or organization. + + 1. The **Install & Authorize** page for the GitHub App appears.