diff --git a/lib/modules/platform/codecommit/index.md b/lib/modules/platform/codecommit/index.md index a1519a76124f9addcfea681386abb4a0958b1372..4c02d3eeb14f3bb0d2304a3fe926ccbff32cbe76 100644 --- a/lib/modules/platform/codecommit/index.md +++ b/lib/modules/platform/codecommit/index.md @@ -8,25 +8,34 @@ First, you need to obtain an AWS [IAM Access Key id and a Secret access key id](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) -Let Renovate use AWS CodeCommit access keys by doing one of the following: +Let Renovate use AWS CodeCommit authentication keys by doing one of the following: -1. Set a Renovate configuration file - config.js and set: +- Set a Renovate configuration file - config.js: - ``` - username: AWS IAM access key id - password: AWS Secret access key - endpoint: the url endpoint e.g https://git-codecommit.us-east-1.amazonaws.com/ - token: AWS session token, if you have one - ``` + ``` + username: AWS IAM access key id + password: AWS Secret access key + endpoint: the url endpoint e.g https://git-codecommit.us-east-1.amazonaws.com/ + token: AWS session token, if you have one + ``` -2. Set up the environment with all required AWS environment variables for authentication, e.g: +- Set up the environment with all required AWS environment variables: - ``` - AWS_ACCESS_KEY_ID: AWS IAM access key id - AWS_SECRET_ACCESS_KEY: AWS Secret access key - AWS_REGION: the AWS region e.g us-east-1 - AWS_SESSION_TOKEN: AWS session token, if you have one - ``` + ``` + AWS_ACCESS_KEY_ID: AWS IAM access key id + AWS_SECRET_ACCESS_KEY: AWS Secret access key + AWS_REGION: the AWS region e.g us-east-1 + AWS_SESSION_TOKEN: AWS session token, if you have one + ``` + +- Set up AWS credentials using CLI parameters: + + ``` + --username: AWS IAM access key id + --password: AWS Secret access key + --endpoint: the url endpoint e.g https://git-codecommit.us-east-1.amazonaws.com/ + --token: AWS session token, if you have one + ``` ## AWS IAM security policies @@ -35,12 +44,12 @@ Let Renovate use AWS CodeCommit access keys by doing one of the following: ## Running Renovate -Set up a global configuration file (config.js) for running Renovate on CodeCommit: +Set up a global configuration file (config.js), or alternatively use CLI params or Environment variables, for running Renovate on CodeCommit: - Set `platform: 'codecommit'` - Set `repositories: ['{repository names separated by comma}']`, or alternatively use Renovate’s [autodiscover](https://docs.renovatebot.com/self-hosted-configuration/#autodiscover) -Run Renovate with the configuration file, and it will create an onboarding Pull Request in your set repositories. +Run Renovate and it will operate on your repositories ## Unsupported platform features/concepts @@ -62,7 +71,14 @@ module.exports = { repositories: ['abc/def', 'abc/ghi'], username: 'ACCESS_KEY_ID_GOES_HERE', password: 'SECRET_ACCESS_KEY_GOES_HERE', + token: 'AWS_SESSION_TOKEN_GOES_HERE', gitAuthor: 'your_email@domain', prConcurrentLimit: 10, + packageRules: [ + { + matchPackageNames: ['package_name', 'package_name2'], + enabled: false, + }, + ], }; ```