設定 Amplify GitHub 庫的存取 - AWS Amplify 託管

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

設定 Amplify GitHub 庫的存取

Amplify 現在使用「 GitHub 應用程式」功能來授權「Amplify」 GitHub 儲存庫的唯讀存取權。使用 Amplify GitHub 應用程式時,權限會進行更微調,讓您僅授與您指定的存放庫的 Amplify 存取權。若要進一步了解 GitHub應用程式,請參閱 GitHub 網站上的關於 GitHub 應用程式

當您連接存儲在存儲 GitHub 庫中的新應用程序時,默認情況下 Amplify 使用該 GitHub 應用程序訪問存儲庫。不過,您先前從存放 GitHub庫連線的現有 Amplify 應用程式會使用 OAuth 進行存取。CI/CD 將繼續適用於這些應用程式,但我們強烈建議您將其移轉為使用新的 Amplify GitHub 應用程式。

當您使用 Amplify 主控台部署新應用程式或移轉現有應用程式時,系統會自動將您導向至 Amplify GitHub 應用程式的安裝位置。若要手動存取應用程式的安裝登陸頁面,請開啟網頁瀏覽器,然後依地區瀏覽至該應用程式。使用該格式https://github.com/apps/aws-amplify-REGION,將 REG ION 替換為您將部署 Amplify 應用程序的區域。例如,若要在美國西部 (奧勒岡) 區域安裝 Amplify GitHub 應用程式,請導覽至 https://github.com/apps/aws-amplify-us-west -2。

為新部署安裝和授權 Amplify GitHub 應用程式

當您從存放 GitHub 庫中的現有代碼部署新的應用程序以 Amplify 時,請使用以下說明安裝和授權該 GitHub 應用程序。

安裝和授權 Amplify GitHub 應用程式
  1. 登入AWS Management Console並開啟 Amplify 大控制台

  2. 從 [所有應用程式] 頁面中,選擇 [新增應程式],然後選擇 [主機

  3. 在 [開始使用 Amplify 主機] 頁面上,選擇 GitHub,然後選擇 [繼續]。

  4. 如果這是第一次連接 GitHub 存儲庫,則在 GitHub .com 上的瀏覽器中會打開一個新頁面,請求授權您AWS Amplify的 GitHub帳戶。選擇 Authorize (授權)。

  5. 接下來,您必須在您的 GitHub 帳戶中安裝 Amplify GitHub 應用程序。在 Github.com 上會開啟一個頁面,要求授權AWS Amplify在您的 GitHub帳戶中安裝和授權。

  6. 選擇您要安裝 Amplify GitHub 應用程式的 GitHub 帳戶。

  7. 執行下列任意一項:

    • 若要將安裝套用至所有儲存庫,請選擇「所有儲存庫」。

    • 若要將安裝限制在您選取的特定儲存庫,請選擇僅選取儲存區域。請務必在您選取的存放庫中包含您要移轉之應用程式的存放庫。

  8. 選擇「安裝和授權」。

  9. 系統會將您重新導向至 Amplify 主控台中應用程式的 [新增存放庫分支] 頁面。

  10. 在「最近更新的儲存庫」清單中,選取要連線的存放庫名稱。

  11. 在「分支」清單中,選取要連線的存放庫分支的名稱。

  12. 選擇 Next (下一步)。

  13. 在 [設定組建設定] 頁面上,選擇 [下一步]。

  14. 在「複查」頁面上,選擇「儲存並部署」。

將現有的OAuth應用程式移轉至 Amplify GitHub 應用程式

您先前從儲存庫連線的現有 Amplify 應用程式會使用 OAuth 進行存放 GitHub 庫存取。強烈建議您遷移這些應用程式,以便使用 Amplify GitHub 應用程式。

使用以下說明遷移應用程序,並在您的 GitHub 帳戶中刪除其相應的 OAuth Webhook。請注意,移轉程序視是否已安裝 Amplify GitHub 應用程式而有所不同。遷移第一個應用程序並安裝並授權該 GitHub 應用程序後,您只需要更新後續應用程序遷移的存儲庫權限。

將應用程序從 OAuth 遷移到 GitHub 應用程序
  1. 登入AWS Management Console並開啟 Amplify 大控制台

  2. 選擇您要遷移的應用程式。

  3. 在應用程序的信息頁面上,找到藍色的遷移到我們的 GitHub應用程序消息,然後選擇開始遷移

  4. 在 [安裝並授權 GitHub 應用程式] 頁面上,選擇 [設定 GitHub 應用程式

  5. 在 GitHub .com 上的瀏覽器中會開啟一個新頁面,要求授權您AWS Amplify的 GitHub 帳戶。選擇 Authorize (授權)。

  6. 選擇您要安裝 Amplify GitHub 應用程式的 GitHub 帳戶。

  7. 執行下列任意一項:

    • 若要將安裝套用至所有儲存庫,請選擇「所有儲存庫」。

    • 若要將安裝限制在您選取的特定儲存庫,請選擇僅選取儲存區域。確保在您選擇的存儲庫中包含要遷移的應用程序的存儲庫。

  8. 選擇「安裝和授權」。

  9. 系統會將您重新導向至 Amplify 主控台中 GitHub 應用程式的「安裝和授權應用程式」頁面。如果 GitHub 授權成功,則會看到成功訊息。選擇,下一步

  10. 在 [完成安裝] 頁面上,選擇 [完成安裝]。此步驟會刪除您現有的 webhook,建立新的 Webhook,然後完成移轉。

為AWS CloudFormation、CLI 和 SDK 部署設定 Amplify GitHub 應用程式

您先前從儲存庫連線的現有 Amplify 應用程式會使用 OAuth 進行存放 GitHub 庫存取。這可能包括您使用 Amplify mand Line Interface (CLI) 或開發套件來部署的應用程式。AWS CloudFormation強烈建議您遷移這些應用程式,以便使用新的 Amplify GitHub 應用程式。移轉必須在中的 Amplify 主控台中執行AWS Management Console。如需相關指示,請參閱將現有的OAuth應用程式移轉至 Amplify GitHub 應用程式

您可以使用AWS CloudFormation Amplify CLI 和 SDK 來部署新的 Amplify 應用程式,該應用程式使用應用 GitHub 程式進行存放庫存取。此程序需要您先在 GitHub 帳戶中安裝 Amplify GitHub 應用程式。接下來,您將需要在您的 GitHub 帳戶中生成個人訪問令牌。最後,部署應用程式並指定個人存取字符。

在您的帳戶中安裝 Amplify GitHub 應用
  1. 開啟網頁瀏覽器,然後導覽至您要部署 GitHub應用程式的AWS區域中 Amplify 應用程式的安裝位置。

    使用格式https://github.com/apps/aws-amplify-REGION/installations/new,用您自己的輸入替換 REGION。例如,如果您在美國西部 (奧勒岡) 區域安裝應用程式,請指定https://github.com/apps/aws-amplify-us-west-2/installations/new

  2. 選擇您要安裝 Amplify GitHub 應用程式的 GitHub 帳戶。

  3. 執行下列任意一項:

    • 若要將安裝套用至所有儲存庫,請選擇「所有儲存庫」。

    • 若要將安裝限制在您選取的特定儲存庫,請選擇僅選取儲存區域。請務必在您選取的存放庫中包含您要移轉之應用程式的存放庫。

  4. 選擇 Install (安裝)

在您的 GitHub 帳戶中生成個人訪問令牌
  1. 登入您的 GitHub 帳戶。

  2. 在右上角,找到您的個人資料照片,然後從菜單中選擇「設置」。

  3. 在左側導覽功能表中,選擇開發人員設定

  4. 在 [GitHub 應用程式] 頁面的左側導覽功能表中,選擇 [個人存取權杖]。

  5. 在 [個人存取權杖] 頁面上,選擇 [產生新權杖]。

  6. 在 [新增個人存取權杖] 頁面上,針對備註輸入權杖的描述性名稱。

  7. [選取範圍] 區段中,選取 [管理員:repo_hook]。

  8. 選擇 Generate token (產生字符)

  9. 複製並儲存個人存取權杖。當您部署具有 CLI 或 SDK 的 Amplify 應用程式時AWS CloudFormation,您將需要提供它。

在您的 GitHub 帳戶中安裝 Amplify GitHub 應用程式並產生個人存取權杖之後,您可以使用 Amplify CLI 或 SDK 部署新的應用程式。AWS CloudFormation使用accessToken欄位來指定您在先前程序中建立的個人存取字符。如需詳細資訊,請參閱 CreateAppA mplify API 參考AWS CloudFormation使用者指南AWS::Amplify::App中的。

下列 CLI 命令會部署使用應用程式進行存放庫存取權的新 Amplify GitHub 應用程式。用您自己的信息替換 myapp-using-githubapphttps://github.com/Myaccount/react-app我的令牌

aws amplify create-app --name myapp-using-githubapp --repository https://github.com/Myaccount/react-app --access-token MY_TOKEN

使用 Amplify GitHub 應用程式設定網頁預覽

Web 預覽會將對 GitHub 儲存庫所做的每個提取要求 (PR) 部署到唯一的預覽 URL。預覽版現在可以使用 Amplify GitHub 應用程式來存取您的 GitHub 軟體庫。如需安裝和授權 GitHub 應用程式進行網頁預覽的說明,請參閱啟用網頁預覽