1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-17 20:47:50 +02:00

docs: update s3.md

Added doc for EnvProvider, SharedCredentialsProvider and
AssumeRoleTokenProvider with enabled SharedConfigState.

#754
This commit is contained in:
Krzysztof Grodzicki 2018-08-23 21:25:35 +02:00 committed by Carlos Alexandro Becker
parent 8595a80384
commit 661f56ac15

View File

@ -52,7 +52,28 @@ s3:
GoReleaser will authenticate using the [same methods defined by aws-cli][auth].
You can read the [docs][auth] to find out more about it.
You can also set diferent profile names for each S3 config, so you may be able
Currently it supports authentication with:
* A [EnvProvider][EnvProvider] which retrieves credentials from the environment variables of the
running process. Environment credentials never expire.
Environment variables used:
* Access Key ID: AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY
* Secret Access Key: AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY
* A [SharedCredentialsProvider][SharedCredentialsProvider] which retrieves credentials from the current user's home
directory, and keeps track if those credentials are expired.
Profile ini file example: $HOME/.aws/credentials
* A AssumeRoleTokenProvider with enabled SharedConfigState which uses MFA prompting for token code on stdin.
Go to [session doc][session] for more details.
You can also set different profile names for each S3 config, so you may be able
to push to buckets in different accounts, for example.
[auth]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html
[envProvider]: https://docs.aws.amazon.com/sdk-for-go/api/aws/credentials/#EnvProvider
[sharedCredentialsProvider]: https://docs.aws.amazon.com/sdk-for-go/api/aws/credentials/#SharedCredentialsProvider
[session]: https://docs.aws.amazon.com/sdk-for-go/api/aws/session/