Skip to content

Commit 12e0bd2

Browse files
committed
chore: Update documentation and CI versions following initial fork of project
1 parent d4c2dce commit 12e0bd2

File tree

14 files changed

+53
-132
lines changed

14 files changed

+53
-132
lines changed

.github/CODEOWNERS

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/CODE_OF_CONDUCT.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

.github/CONTRIBUTING.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,6 @@ GitHub provides additional document on [forking a repository](https://help.githu
4242

4343
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
4444

45-
## Code of Conduct
46-
47-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
48-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
49-
[email protected] with any additional questions or comments.
50-
51-
## Security issue notifications
52-
53-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
54-
5545
## Licensing
5646

5747
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### What does this PR do?
22

33
🛑 Please open an issue first to discuss any significant work and flesh out details/direction - we would hate for your time to be wasted.
4-
Consult the [CONTRIBUTING](https://github.com/aws-ia/terraform-aws-eks-addon/.github/blob/main/CONTRIBUTING.md#contributing-via-pull-requests) guide for submitting pull-requests.
4+
Consult the [CONTRIBUTING](https://github.com/aws-blueprints/terraform-aws-eks-addon/.github/blob/main/CONTRIBUTING.md#contributing-via-pull-requests) guide for submitting pull-requests.
55

66
<!-- A brief description of the change being made with this pull request. -->
77

.github/workflows/pr-title.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
name: Validate PR title
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: amannn/action-semantic-pull-request@v5.2.0
15+
- uses: amannn/action-semantic-pull-request@v6.1.1
1616
env:
1717
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1818
with:

.github/workflows/pre-commit.yaml

Lines changed: 25 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,14 @@
1-
name: pre-commit
1+
name: Pre-Commit
22

33
on:
44
pull_request:
55
branches:
66
- main
7-
paths:
8-
- '**.tf'
9-
- '**.yml'
10-
- '**.yaml'
11-
12-
permissions: read-all
7+
- master
138

149
env:
15-
TERRAFORM_DOCS_VERSION: v0.16.0
16-
TFSEC_VERSION: v1.28.1
17-
TF_PLUGIN_CACHE_DIR: ${{ github.workspace }}/.terraform.d/plugin-cache
18-
TFLINT_VERSION: v0.45.0
19-
20-
concurrency:
21-
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
22-
cancel-in-progress: true
10+
TERRAFORM_DOCS_VERSION: v0.20.0
11+
TFLINT_VERSION: v0.59.1
2312

2413
jobs:
2514
collectInputs:
@@ -29,11 +18,11 @@ jobs:
2918
directories: ${{ steps.dirs.outputs.directories }}
3019
steps:
3120
- name: Checkout
32-
uses: actions/checkout@v3
21+
uses: actions/checkout@v5
3322

3423
- name: Get root directories
3524
id: dirs
36-
uses: clowdhaus/terraform-composite-actions/directories@v1.8.3
25+
uses: clowdhaus/terraform-composite-actions/directories@v1.14.0
3726

3827
preCommitMinVersions:
3928
name: Min TF pre-commit
@@ -43,100 +32,56 @@ jobs:
4332
matrix:
4433
directory: ${{ fromJson(needs.collectInputs.outputs.directories) }}
4534
steps:
46-
- name: Remove default Terraform
47-
run: rm -rf $(which terraform)
48-
4935
- name: Checkout
50-
uses: actions/checkout@v3
51-
52-
- uses: dorny/paths-filter@v2
53-
id: changes
54-
with:
55-
# We only need to check Terraform files for the current directory
56-
# because the `preCommitMaxVersion` job will run the full,
57-
# exhaustive checks (always)
58-
filters: |
59-
src:
60-
- '${{ matrix.directory }}/*.tf'
61-
62-
- name: Config Terraform plugin cache
63-
if: steps.changes.outputs.src== 'true'
64-
run: mkdir --parents ${{ env.TERRAFORM_DOCS_VERSION }}
65-
66-
- name: Cache Terraform
67-
uses: actions/cache@v3
68-
if: steps.changes.outputs.src== 'true'
69-
with:
70-
path: ${{ env.TERRAFORM_DOCS_VERSION }}
71-
key: ${{ runner.os }}-terraform-${{ hashFiles('**/.terraform.lock.hcl') }}
72-
restore-keys: ${{ runner.os }}-terraform-
36+
uses: actions/checkout@v5
7337

7438
- name: Terraform min/max versions
75-
uses: clowdhaus/[email protected]
76-
if: steps.changes.outputs.src== 'true'
7739
id: minMax
40+
uses: clowdhaus/[email protected]
7841
with:
7942
directory: ${{ matrix.directory }}
8043

8144
- name: Pre-commit Terraform ${{ steps.minMax.outputs.minVersion }}
82-
uses: clowdhaus/terraform-composite-actions/[email protected]
8345
# Run only validate pre-commit check on min version supported
84-
if: ${{ matrix.directory != '.' && steps.changes.outputs.src== 'true' }}
46+
if: ${{ matrix.directory != '.' }}
47+
uses: clowdhaus/terraform-composite-actions/[email protected]
8548
with:
8649
terraform-version: ${{ steps.minMax.outputs.minVersion }}
50+
tflint-version: ${{ env.TFLINT_VERSION }}
8751
args: 'terraform_validate --color=always --show-diff-on-failure --files ${{ matrix.directory }}/*'
8852

8953
- name: Pre-commit Terraform ${{ steps.minMax.outputs.minVersion }}
90-
uses: clowdhaus/terraform-composite-actions/[email protected]
9154
# Run only validate pre-commit check on min version supported
92-
if: ${{ matrix.directory == '.' && steps.changes.outputs.src== 'true' }}
55+
if: ${{ matrix.directory == '.' }}
56+
uses: clowdhaus/terraform-composite-actions/[email protected]
9357
with:
9458
terraform-version: ${{ steps.minMax.outputs.minVersion }}
59+
tflint-version: ${{ env.TFLINT_VERSION }}
9560
args: 'terraform_validate --color=always --show-diff-on-failure --files $(ls *.tf)'
9661

9762
preCommitMaxVersion:
9863
name: Max TF pre-commit
9964
runs-on: ubuntu-latest
10065
needs: collectInputs
10166
steps:
102-
- name: Remove default Terraform
103-
run: rm -rf $(which terraform)
104-
10567
- name: Checkout
106-
uses: actions/checkout@v3
107-
108-
- uses: dorny/paths-filter@v2
109-
id: changes
110-
with:
111-
filters: |
112-
src:
113-
- '**/*.tf'
114-
115-
- name: Config Terraform plugin cache
116-
if: steps.changes.outputs.src== 'true'
117-
run: mkdir --parents ${{ env.TERRAFORM_DOCS_VERSION }}
118-
119-
- name: Cache Terraform
120-
uses: actions/cache@v3
121-
if: steps.changes.outputs.src== 'true'
68+
uses: actions/checkout@v5
12269
with:
123-
path: ${{ env.TF_PLUGIN_CACHE_DIR }}
124-
key: ${{ runner.os }}-terraform-${{ hashFiles('**/.terraform.lock.hcl') }}
125-
restore-keys: ${{ runner.os }}-terraform-
126-
127-
- name: Install tfsec
128-
if: steps.changes.outputs.src== 'true'
129-
run: curl -sSLo ./tfsec https://github.com/aquasecurity/tfsec/releases/download/${{ env.TFSEC_VERSION }}/tfsec-$(uname)-amd64 && chmod +x tfsec && sudo mv tfsec /usr/bin/
70+
ref: ${{ github.event.pull_request.head.ref }}
71+
repository: ${{github.event.pull_request.head.repo.full_name}}
13072

13173
- name: Terraform min/max versions
13274
id: minMax
133-
uses: clowdhaus/[email protected]
134-
if: steps.changes.outputs.src== 'true'
75+
uses: clowdhaus/[email protected]
76+
77+
- name: Hide template dir
78+
# Special to this repo, we don't want to check this dir
79+
if: ${{ github.repository == 'terraform-aws-modules/terraform-aws-security-group' }}
80+
run: rm -rf modules/_templates
13581

13682
- name: Pre-commit Terraform ${{ steps.minMax.outputs.maxVersion }}
137-
uses: clowdhaus/terraform-composite-actions/[email protected]
138-
if: steps.changes.outputs.src== 'true'
83+
uses: clowdhaus/terraform-composite-actions/[email protected]
13984
with:
14085
terraform-version: ${{ steps.minMax.outputs.maxVersion }}
141-
terraform-docs-version: ${{ env.TERRAFORM_DOCS_VERSION }}
14286
tflint-version: ${{ env.TFLINT_VERSION }}
87+
terraform-docs-version: ${{ env.TERRAFORM_DOCS_VERSION }}

.github/workflows/stale-issue-pr.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
issues: write
1515
pull-requests: write
1616
steps:
17-
- uses: actions/stale@v6
17+
- uses: actions/stale@v10
1818
id: stale
1919
with:
2020
ascending: true

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: https://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.96.1
3+
rev: v1.103.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_validate
@@ -23,7 +23,7 @@ repos:
2323
- '--args=--only=terraform_standard_module_structure'
2424
- '--args=--only=terraform_workspace_remote'
2525
- repo: https://github.com/pre-commit/pre-commit-hooks
26-
rev: v4.6.0
26+
rev: v6.0.0
2727
hooks:
2828
- id: check-merge-conflict
2929
- id: end-of-file-fixer

NOTICE.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Terraform module which provisions an addon ([Helm release](https://registry.terr
88

99
```hcl
1010
module "eks_blueprints_addon" {
11-
source = "aws-ia/eks-blueprints-addon/aws"
11+
source = "aws-blueprints/eks-blueprints-addon/aws"
1212
version = "~> 1.0" #ensure to update this to the latest/desired version
1313
1414
chart = "karpenter"
@@ -65,7 +65,7 @@ module "eks_blueprints_addon" {
6565

6666
```hcl
6767
module "eks_blueprints_addon" {
68-
source = "aws-ia/eks-blueprints-addon/aws"
68+
source = "aws-blueprints/eks-blueprints-addon/aws"
6969
version = "~> 1.0" #ensure to update this to the latest/desired version
7070
7171
chart = "metrics-server"
@@ -96,7 +96,7 @@ module "eks_blueprints_addon" {
9696

9797
```hcl
9898
module "eks_blueprints_addon" {
99-
source = "aws-ia/eks-blueprints-addon/aws"
99+
source = "aws-blueprints/eks-blueprints-addon/aws"
100100
version = "~> 1.0" #ensure to update this to the latest/desired version
101101
102102
# Disable helm release
@@ -129,25 +129,25 @@ module "eks_blueprints_addon" {
129129
> [!IMPORTANT]
130130
> EKS Blueprints for Terraform is maintained by AWS Solution Architects. It is not part of an AWS
131131
> service and support is provided as a best-effort by the EKS Blueprints community. To provide feedback,
132-
> please use the [issues templates](https://github.com/aws-ia/terraform-aws-eks-blueprints-addon/issues)
132+
> please use the [issues templates](https://github.com/aws-blueprints/terraform-aws-eks-blueprints-addon/issues)
133133
> provided. If you are interested in contributing to EKS Blueprints, see the
134-
> [Contribution guide](https://github.com/aws-ia/terraform-aws-eks-blueprints-addon/blob/main/.github/CONTRIBUTING.md).
134+
> [Contribution guide](https://github.com/aws-blueprints/terraform-aws-eks-blueprints-addon/blob/main/.github/CONTRIBUTING.md).
135135
136-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
136+
<!-- BEGIN_TF_DOCS -->
137137
## Requirements
138138

139139
| Name | Version |
140140
|------|---------|
141141
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
142-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.47 |
143-
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.9 |
142+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.47, < 6.0 |
143+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.9, < 3.0 |
144144

145145
## Providers
146146

147147
| Name | Version |
148148
|------|---------|
149-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.47 |
150-
| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.9 |
149+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.47, < 6.0 |
150+
| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.9, < 3.0 |
151151

152152
## Modules
153153

@@ -248,14 +248,12 @@ No modules.
248248
| <a name="output_revision"></a> [revision](#output\_revision) | Version is an int32 which represents the version of the release |
249249
| <a name="output_values"></a> [values](#output\_values) | The compounded values from `values` and `set*` attributes |
250250
| <a name="output_version"></a> [version](#output\_version) | A SemVer 2 conformant version string of the chart |
251-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
251+
<!-- END_TF_DOCS -->
252252

253253
## Community
254254

255-
- [Code of conduct](.github/CODE_OF_CONDUCT.md)
256255
- [Contributing](.github/CONTRIBUTING.md)
257-
- [Security issue notifications](.github/CONTRIBUTING.md#security-issue-notifications)
258256

259257
## License
260258

261-
Apache-2.0 Licensed. See [LICENSE](https://github.com/aws-ia/terraform-aws-eks-blueprints-addon/blob/main/LICENSE).
259+
Apache-2.0 Licensed. See [LICENSE](https://github.com/aws-blueprints/terraform-aws-eks-blueprints-addon/blob/main/LICENSE).

0 commit comments

Comments
 (0)