Skip to content

Commit 2df9cae

Browse files
committed
Removed explicit version in the documentation and added note about adding it back
1 parent 6898577 commit 2df9cae

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Add the module to one of your Terraform configurations to create an OIDC provide
1111

1212
```hcl
1313
module "oidc_auth" {
14-
source = "github.com/moritzheiber/terraform-aws-oidc-github-actions-module?ref=v0.2.2"
14+
source = "github.com/moritzheiber/terraform-aws-oidc-github-actions-module"
1515
1616
github_repositories = toset(["my-org/my-repository"])
1717
role_names = toset(["some-role"])
@@ -22,6 +22,8 @@ output "github_actions_roles" {
2222
}
2323
```
2424

25+
\_Note: Usually you will want to use a specific version of the module by using the `version` attribute.\_
26+
2527
Continue with assigning permissions to these roles:
2628

2729
```hcl

docs/header.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Add the module to one of your Terraform configurations to create an OIDC provide
1010

1111
```hcl
1212
module "oidc_auth" {
13-
source = "github.com/moritzheiber/terraform-aws-oidc-github-actions-module?ref=v0.2.2"
13+
source = "github.com/moritzheiber/terraform-aws-oidc-github-actions-module"
1414
1515
github_repositories = toset(["my-org/my-repository"])
1616
role_names = toset(["some-role"])
@@ -21,6 +21,8 @@ output "github_actions_roles" {
2121
}
2222
```
2323

24+
_Note: Usually you will want to use a specific version of the module by using the `version` attribute._
25+
2426
Continue with assigning permissions to these roles:
2527

2628
```hcl

0 commit comments

Comments
 (0)