Skip to content

Commit e13edb5

Browse files
committed
fix: update documentation
1 parent 708e4e0 commit e13edb5

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,17 @@ Allows to use Maven backed by AWS CodeArtifact repository in GitHub Actions:
88

99
Designed to be used in your build workflow when you need to access packages from CodeArtifact.
1010
It is also used in publish workflow to upload packages in CodeArtifact.
11-
It is recommended to use different IAM roles: `/ci/builder` and `/ci/publisher` respectfully.
1211
For release workflow you likely want to bump a version in `pom.xml` file and add some git tags,
13-
so please check the `agilecustoms/release` action - it represents a holistic release action (uses `setup-maven-codeartifact` under the hood).
12+
so please check the [agilecustoms/publish](https://github.com/agilecustoms/publish) action —
13+
it represents a holistic release action (uses `setup-maven-codeartifact` under the hood).
14+
15+
For build and publish workflows it is recommended to use different IAM roles: `/ci/builder` and `/ci/publisher`.
16+
Below there are two terraform modules that have all necessary permissions to work with CodeArtifact:
17+
- [ci-builder](https://github.com/agilecustoms/terraform-aws-ci-builder)
18+
- [ci-publisher](https://github.com/agilecustoms/terraform-aws-ci-publisher)
19+
20+
And this is [example](https://github.com/agilecustoms/terraform-aws-ci-publisher?tab=readme-ov-file#how-to-create-a-role-with-this-policy)
21+
how to create AWS IAM role based of these policies with password-less trust policy
1422

1523
This action is a combination of few other actions mainly `actions/setup-java` and `aws-actions/configure-aws-credentials`,
1624
hence all parameters have prefix either `java-` (for java-specific settings) or `aws-` (for authorization in aws)

0 commit comments

Comments
 (0)