Skip to content

Commit 41e56c9

Browse files
authored
Merge pull request #48 from cisagov/lineage/skeleton
⚠️ CONFLICT! Lineage pull request for: skeleton
2 parents 242bb96 + 61864a7 commit 41e56c9

File tree

10 files changed

+68
-60
lines changed

10 files changed

+68
-60
lines changed

.github/workflows/build.yml

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ on: # yamllint disable-line rule:truthy
55
merge_group:
66
types:
77
- checks_requested
8+
# We use the default activity types for the pull_request event as specified here:
9+
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
810
pull_request:
911
push:
1012
repository_dispatch:
@@ -23,7 +25,7 @@ env:
2325
PIP_CACHE_DIR: ~/.cache/pip
2426
PRE_COMMIT_CACHE_DIR: ~/.cache/pre-commit
2527
RUN_TMATE: ${{ secrets.RUN_TMATE }}
26-
TERRAFORM_DOCS_REPO_BRANCH_NAME: improvement/support_atx_closed_markdown_headers
28+
TERRAFORM_DOCS_REPO_BRANCH_NAME: cisagov
2729
TERRAFORM_DOCS_REPO_DEPTH: 1
2830
TERRAFORM_DOCS_REPO_URL: https://github.com/mcdonnnj/terraform-docs.git
2931

@@ -118,18 +120,20 @@ jobs:
118120
name: Lookup Go cache directory
119121
run: |
120122
echo "dir=$(go env GOCACHE)" >> $GITHUB_OUTPUT
121-
- uses: actions/cache@v4
123+
- uses: actions/cache@v5
122124
env:
123-
BASE_CACHE_KEY: ${{ github.job }}-${{ runner.os }}-\
124-
py${{ steps.setup-python.outputs.python-version }}-\
125-
go${{ steps.setup-go.outputs.go-version }}-\
126-
packer${{ steps.setup-env.outputs.packer-version }}-\
127-
tf${{ steps.setup-env.outputs.terraform-version }}-
125+
BASE_CACHE_KEY: >-
126+
${{ github.job }}-${{ runner.os
127+
}}-py${{ steps.setup-python.outputs.python-version
128+
}}-go${{ steps.setup-go.outputs.go-version
129+
}}-packer${{ steps.setup-env.outputs.packer-version
130+
}}-tf${{ steps.setup-env.outputs.terraform-version }}-
128131
with:
129-
key: ${{ env.BASE_CACHE_KEY }}\
130-
${{ hashFiles('**/requirements-test.txt') }}-\
131-
${{ hashFiles('**/requirements.txt') }}-\
132-
${{ hashFiles('**/.pre-commit-config.yaml') }}
132+
key: >-
133+
${{ env.BASE_CACHE_KEY }}${{
134+
hashFiles('**/requirements-test.txt') }}-${{
135+
hashFiles('**/requirements.txt') }}-${{
136+
hashFiles('**/.pre-commit-config.yaml') }}
133137
# Note that the .terraform directory IS NOT included in the
134138
# cache because if we were caching, then we would need to use
135139
# the `-upgrade=true` option. This option blindly pulls down the
@@ -169,10 +173,13 @@ jobs:
169173
PACKAGE_VERSION: ${{ steps.setup-env.outputs.staticcheck-version }}
170174
run: go install ${PACKAGE_URL}@${PACKAGE_VERSION}
171175
# TODO: https://github.com/cisagov/skeleton-generic/issues/165
172-
# We are temporarily using @mcdonnnj's forked branch of terraform-docs
173-
# until his PR: https://github.com/terraform-docs/terraform-docs/pull/745
174-
# is approved. This temporary fix will allow for ATX header support when
175-
# terraform-docs is run during linting.
176+
# We are temporarily using a branch of @mcdonnnj's fork of terraform-docs that
177+
# groups changes from his PRs until they are approved and merged:
178+
# https://github.com/terraform-docs/terraform-docs/pull/745
179+
# https://github.com/terraform-docs/terraform-docs/pull/901
180+
# This temporary fix will allow for ATX header support when terraform-docs is run
181+
# during linting and output delimiter rows with cell spacing that passes
182+
# Markdownlint's MD060/table-column-style rule.
176183
- name: Clone ATX headers branch from terraform-docs fork
177184
run: |
178185
git clone \
@@ -187,7 +194,7 @@ jobs:
187194
-o $(go env GOPATH)/bin/terraform-docs
188195
- name: Install dependencies
189196
run: |
190-
python -m pip install --upgrade pip setuptools wheel
197+
python -m pip install --upgrade pip setuptools
191198
pip install --upgrade --requirement requirements-test.txt
192199
- name: Set up pre-commit hook environments
193200
run: pre-commit install-hooks

.github/workflows/codeql-analysis.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ on:
1212
merge_group:
1313
types:
1414
- checks_requested
15+
# We use the default activity types for the pull_request event as specified here:
16+
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
1517
pull_request:
1618
# The branches here must be a subset of the ones in the push key
1719
branches:

.github/workflows/dependency-review.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ on: # yamllint disable-line rule:truthy
55
merge_group:
66
types:
77
- checks_requested
8+
# We use the default activity types for the pull_request event as specified here:
9+
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
810
pull_request:
911

1012
# Set a default shell for any run steps. The `-Eueo pipefail` sets errtrace,

.github/workflows/label-prs.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
name: Label pull requests
33

44
on: # yamllint disable-line rule:truthy
5+
# We use the default activity types for the pull_request event as specified here:
6+
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request
57
pull_request:
6-
types:
7-
- edited
8-
- opened
9-
- synchronize
108

119
# Set a default shell for any run steps. The `-Eueo pipefail` sets errtrace,
1210
# nounset, errexit, and pipefail. The `-x` will print all commands as they are

.pre-commit-config.yaml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,32 +45,32 @@ repos:
4545

4646
# Text file hooks
4747
- repo: https://github.com/igorshubovych/markdownlint-cli
48-
rev: v0.45.0
48+
rev: v0.47.0
4949
hooks:
5050
- id: markdownlint
5151
args:
5252
- --config=.mdl_config.yaml
5353
- repo: https://github.com/rbubley/mirrors-prettier
54-
rev: v3.6.2
54+
rev: v3.8.1
5555
hooks:
5656
- id: prettier
5757
- repo: https://github.com/adrienverge/yamllint
58-
rev: v1.37.1
58+
rev: v1.38.0
5959
hooks:
6060
- id: yamllint
6161
args:
6262
- --strict
6363

6464
# GitHub Actions hooks
6565
- repo: https://github.com/python-jsonschema/check-jsonschema
66-
rev: 0.35.0
66+
rev: 0.36.2
6767
hooks:
6868
- id: check-github-actions
6969
- id: check-github-workflows
7070

7171
# pre-commit hooks
7272
- repo: https://github.com/pre-commit/pre-commit
73-
rev: v4.4.0
73+
rev: v4.5.1
7474
hooks:
7575
- id: validate_manifest
7676

@@ -129,13 +129,13 @@ repos:
129129

130130
# Python hooks
131131
- repo: https://github.com/PyCQA/bandit
132-
rev: 1.9.1
132+
rev: 1.9.3
133133
hooks:
134134
- id: bandit
135135
args:
136136
- --config=.bandit.yml
137137
- repo: https://github.com/psf/black-pre-commit-mirror
138-
rev: 25.11.0
138+
rev: 26.1.0
139139
hooks:
140140
- id: black
141141
- repo: https://github.com/PyCQA/flake8
@@ -145,15 +145,15 @@ repos:
145145
additional_dependencies:
146146
- flake8-docstrings==1.7.0
147147
- repo: https://github.com/PyCQA/isort
148-
rev: 7.0.0
148+
rev: 8.0.0
149149
hooks:
150150
- id: isort
151151
- repo: https://github.com/pre-commit/mirrors-mypy
152-
rev: v1.18.2
152+
rev: v1.19.1
153153
hooks:
154154
- id: mypy
155155
- repo: https://github.com/pypa/pip-audit
156-
rev: v2.9.0
156+
rev: v2.10.0
157157
hooks:
158158
- id: pip-audit
159159
args:
@@ -165,7 +165,7 @@ repos:
165165
- --requirement
166166
- requirements.txt
167167
- repo: https://github.com/asottile/pyupgrade
168-
rev: v3.21.1
168+
rev: v3.21.2
169169
hooks:
170170
- id: pyupgrade
171171
args:
@@ -177,7 +177,7 @@ repos:
177177

178178
# Ansible hooks
179179
- repo: https://github.com/ansible/ansible-lint
180-
rev: v25.11.1
180+
rev: v26.1.1
181181
hooks:
182182
- id: ansible-lint
183183
additional_dependencies:
@@ -203,7 +203,7 @@ repos:
203203

204204
# Terraform hooks
205205
- repo: https://github.com/antonbabenko/pre-commit-terraform
206-
rev: v1.103.0
206+
rev: v1.105.0
207207
hooks:
208208
- id: terraform_fmt
209209
- id: terraform_validate

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,14 @@ This meta-role requires a permission policy similar to the following:
7676
## Requirements ##
7777

7878
| Name | Version |
79-
|------|---------|
79+
| ---- | ------- |
8080
| terraform | >= 1.1 |
8181
| aws | >= 4.9 |
8282

8383
## Providers ##
8484

8585
| Name | Version |
86-
|------|---------|
86+
| ---- | ------- |
8787
| aws | >= 4.9 |
8888

8989
## Modules ##
@@ -93,7 +93,7 @@ No modules.
9393
## Resources ##
9494

9595
| Name | Type |
96-
|------|------|
96+
| ---- | ---- |
9797
| [aws_iam_policy.ssm_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
9898
| [aws_iam_role.ssm_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
9999
| [aws_iam_role_policy_attachment.ssm_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
@@ -104,7 +104,7 @@ No modules.
104104
## Inputs ##
105105

106106
| Name | Description | Type | Default | Required |
107-
|------|-------------|------|---------|:--------:|
107+
| ---- | ----------- | ---- | ------- | :------: |
108108
| account\_ids | AWS account IDs that are allowed to assume the role. | `list(string)` | `[]` | no |
109109
| entity\_name | The name of the entity that the role is being created for (e.g. "test-user" or "host.example.com"). | `string` | n/a | yes |
110110
| iam\_usernames | The list of IAM usernames allowed to assume the role. If not provided, defaults to allowing any user in the specified account(s). Note that including "root" in this list will override any other usernames in the list. | `list(string)` | ```[ "root" ]``` | no |
@@ -116,7 +116,7 @@ No modules.
116116
## Outputs ##
117117

118118
| Name | Description |
119-
|------|-------------|
119+
| ---- | ----------- |
120120
| policy | The IAM policy that can read the specified SSM Parameter Store parameters. |
121121
| role | The IAM role that can read the specified SSM Parameter Store parameters. |
122122
<!-- END_TF_DOCS -->

examples/basic_usage/.terraform.lock.hcl

Lines changed: 16 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/basic_usage/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Note that this example may create resources which cost money. Run
1212
## Requirements ##
1313

1414
| Name | Version |
15-
|------|---------|
15+
| ---- | ------- |
1616
| terraform | ~> 1.1 |
1717
| aws | ~> 6.7 |
1818

@@ -23,7 +23,7 @@ No providers.
2323
## Modules ##
2424

2525
| Name | Source | Version |
26-
|------|--------|---------|
26+
| ---- | ------ | ------- |
2727
| ssm\_role | ../../ | n/a |
2828

2929
## Resources ##
@@ -37,7 +37,7 @@ No inputs.
3737
## Outputs ##
3838

3939
| Name | Description |
40-
|------|-------------|
40+
| ---- | ----------- |
4141
| policy | The IAM policy that can read the specified SSM Parameter Store parameters for site.example.com. |
4242
| role | The IAM role that can read the specified SSM Parameter Store parameters for site.example.com. |
4343
<!-- END_TF_DOCS -->

requirements.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
setuptools
2-
wheel
1+
setuptools>=70.1

setup-env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ fi
271271
pyenv local "${env_name}"
272272

273273
# Upgrade pip and friends
274-
python3 -m pip install --upgrade pip setuptools wheel
274+
python3 -m pip install --upgrade pip setuptools
275275

276276
# Find a requirements file (if possible) and install
277277
for req_file in "requirements-dev.txt" "requirements-test.txt" "requirements.txt"; do

0 commit comments

Comments
 (0)