The right way to Setup Credential Helper for AWS CodeCommit


AWS CodeCommit is a git code repository service by Amazon Net Providers.

You’ll want to clone your repository and setup your remotes utilizing credential helper.

Step 1 – Setup Credential Helper

git config --global credential.helper '!aws codecommit credential-helper [email protected]'
git config --global credential.UseHttpPath true

It will write to your native consumer’s ~/.gitconfig, and the file will look one thing like:

[credential]    
    helper = !aws --profile CodeCommitProfile codecommit credential-helper [email protected]
    UseHttpPath = true

You may edit this file by working the next git command:

git config --global --edit

Step 2 – Non-obligatory – If utilizing MacOS

By connecting to the CodeCommit repository with HTTPS, the entry is by default short-term, and connections will begin failing after about quarter-hour.

To repair this, you should:

  • Set up a model of Git that doesn’t use the keychain by default.
  • Configure the Keychain Entry utility to not present credentials for CodeCommit repositories.
  1. Open the Keychain Entry utility. (You should utilize Finder to find it.)
  2. Seek for git-codecommit.us-east-2.amazonaws.com. Spotlight the row, open the context menu or right-click it, after which select Get Data.
  3. Select the Entry Management tab.
  4. In Verify earlier than permitting entry, select git-credential-osxkeychain, after which select the minus signal to take away it from the record.

After you take away git-credential-osxkeychain from the record, you see a pop-up message everytime you run a Git command. Select Deny to proceed. For those who discover the pop-ups too disruptive, listed here are another choices:

Step 3 – Git Clone the Repository

At this stage now you can git clone the repository in CodeCommit.

Open the CodeCommit console at https://console.aws.amazon.com/codesuite/codecommit/dwelling.

Discover the repository you need to hook up with from the record and select it. Select Clone URL, after which select the protocol you need to use when cloning or connecting to the repository. This copies the clone URL.

git clone https://git-codecommit.us-east-2.amazonaws.com/v1/repos/your-repo your-repo-directory

Further notes

In case you are cloning as a part of a profile title in your ~/.aws/config, then you have to to set the AWS_PROFILE setting variable as follows:

export AWS_PROFILE = "<profile_name"

Leave a Reply