Skip to content

Commit afb545c

Browse files
committed
Merge github.com:cisagov/skeleton-generic into lineage/skeleton
2 parents b212e93 + 37010e5 commit afb545c

File tree

10 files changed

+201
-33
lines changed

10 files changed

+201
-33
lines changed

.github/dependabot.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ updates:
1212
- dependency-name: actions/cache
1313
- dependency-name: actions/checkout
1414
- dependency-name: actions/dependency-review-action
15+
# - dependency-name: actions/labeler
1516
- dependency-name: actions/setup-go
1617
- dependency-name: actions/setup-python
1718
- dependency-name: cisagov/action-job-preamble
@@ -21,6 +22,12 @@ updates:
2122
- dependency-name: hashicorp/setup-packer
2223
- dependency-name: hashicorp/setup-terraform
2324
- dependency-name: mxschmitt/action-tmate
25+
labels:
26+
# dependabot default we need to replicate
27+
- dependencies
28+
# This matches our label definition in .github/labels.yml as opposed to
29+
# dependabot's default of `github_actions`.
30+
- github-actions
2431
package-ecosystem: github-actions
2532
schedule:
2633
interval: weekly

.github/labeler.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
# Each entry in this file is a label that will be applied to pull requests
3+
# if there is a match based on the matching rules for the entry. Please see
4+
# the actions/labeler documentation for more information:
5+
# https://github.com/actions/labeler#match-object
6+
#
7+
# Note: Verify that the label you want to use is defined in the
8+
# crazy-max/ghaction-github-labeler configuration file located at
9+
# .github/labels.yml.
10+
11+
# Enable if Ansible playbooks are used in the repository.
12+
# ansible:
13+
# - changed-files:
14+
# - any-glob-to-any-file:
15+
# - "**/ansible/**"
16+
dependencies:
17+
- changed-files:
18+
- any-glob-to-any-file:
19+
# Add any dependency files used.
20+
- .pre-commit-config.yaml
21+
- requirements*.txt
22+
documentation:
23+
- changed-files:
24+
- any-glob-to-any-file:
25+
- "**/*.md"
26+
github-actions:
27+
- changed-files:
28+
- any-glob-to-any-file:
29+
- .github/workflows/**
30+
# Enable if Packer is used in the repository.
31+
# packer:
32+
# - changed-files:
33+
# - any-glob-to-any-file:
34+
# - "**/*.pkr.hcl"
35+
# Enable if Python is used in the repository.
36+
# python:
37+
# - changed-files:
38+
# - any-glob-to-any-file:
39+
# - "**/*.py"
40+
# Enable if Terraform is used in the repository.
41+
# terraform:
42+
# - changed-files:
43+
# - any-glob-to-any-file:
44+
# - "**/*.tf"
45+
test:
46+
- changed-files:
47+
- any-glob-to-any-file:
48+
# Add any test-related files or paths.
49+
- .ansible-lint
50+
- .bandit.yml
51+
- .flake8
52+
- .isort.cfg
53+
- .mdl_config.yaml
54+
- .yamllint
55+
upstream update:
56+
- head-branch:
57+
# Any Lineage pull requests should use this branch.
58+
- lineage/skeleton
59+
version bump:
60+
- changed-files:
61+
- any-glob-to-any-file:
62+
# Ensure this matches your version tracking file(s).
63+
- version.txt

.github/workflows/build.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,16 +99,16 @@ jobs:
9999
# this workflow.
100100
permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }}
101101
- id: setup-env
102-
uses: cisagov/setup-env-github-action@develop
103-
- uses: actions/checkout@v4
102+
uses: cisagov/setup-env-github-action@v1
103+
- uses: actions/checkout@v5
104104
- id: setup-python
105-
uses: actions/setup-python@v5
105+
uses: actions/setup-python@v6
106106
with:
107107
python-version: ${{ steps.setup-env.outputs.python-version }}
108108
# We need the Go version and Go cache location for the actions/cache step,
109109
# so the Go installation must happen before that.
110110
- id: setup-go
111-
uses: actions/setup-go@v5
111+
uses: actions/setup-go@v6
112112
with:
113113
# There is no expectation for actual Go code so we disable caching as
114114
# it relies on the existence of a go.sum file.

.github/workflows/codeql-analysis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ jobs:
113113
permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }}
114114

115115
- name: Checkout repository
116-
uses: actions/checkout@v4
116+
uses: actions/checkout@v5
117117

118118
# Initializes the CodeQL tools for scanning.
119119
- name: Initialize CodeQL

.github/workflows/dependency-review.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ jobs:
8989
permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }}
9090
- id: checkout-repo
9191
name: Checkout the repository
92-
uses: actions/checkout@v4
92+
uses: actions/checkout@v5
9393
- id: dependency-review
9494
name: Review dependency changes for vulnerabilities and license changes
9595
uses: actions/dependency-review-action@v4

.github/workflows/label-prs.yml

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
name: Label pull requests
3+
4+
on: # yamllint disable-line rule:truthy
5+
pull_request:
6+
types:
7+
- edited
8+
- opened
9+
- synchronize
10+
11+
# Set a default shell for any run steps. The `-Eueo pipefail` sets errtrace,
12+
# nounset, errexit, and pipefail. The `-x` will print all commands as they are
13+
# run. Please see the GitHub Actions documentation for more information:
14+
# https://docs.github.com/en/actions/using-jobs/setting-default-values-for-jobs
15+
defaults:
16+
run:
17+
shell: bash -Eueo pipefail -x {0}
18+
19+
jobs:
20+
diagnostics:
21+
name: Run diagnostics
22+
# This job does not need any permissions
23+
permissions: {}
24+
runs-on: ubuntu-latest
25+
steps:
26+
# Note that a duplicate of this step must be added at the top of
27+
# each job.
28+
- name: Apply standard cisagov job preamble
29+
uses: cisagov/action-job-preamble@v1
30+
with:
31+
check_github_status: "true"
32+
# This functionality is poorly implemented and has been
33+
# causing problems due to the MITM implementation hogging or
34+
# leaking memory. As a result we disable it by default. If
35+
# you want to temporarily enable it, simply set
36+
# monitor_permissions equal to "true".
37+
#
38+
# TODO: Re-enable this functionality when practical. See
39+
# cisagov/skeleton-generic#207 for more details.
40+
monitor_permissions: "false"
41+
output_workflow_context: "true"
42+
# Use a variable to specify the permissions monitoring
43+
# configuration. By default this will yield the
44+
# configuration stored in the cisagov organization-level
45+
# variable, but if you want to use a different configuration
46+
# then simply:
47+
# 1. Create a repository-level variable with the name
48+
# ACTIONS_PERMISSIONS_CONFIG.
49+
# 2. Set this new variable's value to the configuration you
50+
# want to use for this repository.
51+
#
52+
# Note in particular that changing the permissions
53+
# monitoring configuration *does not* require you to modify
54+
# this workflow.
55+
permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }}
56+
label:
57+
needs:
58+
- diagnostics
59+
permissions:
60+
# Permissions required by actions/labeler
61+
contents: read
62+
issues: write
63+
pull-requests: write
64+
runs-on: ubuntu-latest
65+
steps:
66+
- name: Apply standard cisagov job preamble
67+
uses: cisagov/action-job-preamble@v1
68+
with:
69+
# This functionality is poorly implemented and has been
70+
# causing problems due to the MITM implementation hogging or
71+
# leaking memory. As a result we disable it by default. If
72+
# you want to temporarily enable it, simply set
73+
# monitor_permissions equal to "true".
74+
#
75+
# TODO: Re-enable this functionality when practical. See
76+
# cisagov/skeleton-generic#207 for more details.
77+
monitor_permissions: "false"
78+
# Use a variable to specify the permissions monitoring
79+
# configuration. By default this will yield the
80+
# configuration stored in the cisagov organization-level
81+
# variable, but if you want to use a different configuration
82+
# then simply:
83+
# 1. Create a repository-level variable with the name
84+
# ACTIONS_PERMISSIONS_CONFIG.
85+
# 2. Set this new variable's value to the configuration you
86+
# want to use for this repository.
87+
#
88+
# Note in particular that changing the permissions
89+
# monitoring configuration *does not* require you to modify
90+
# this workflow.
91+
permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }}
92+
- name: Apply suitable labels to a pull request
93+
uses: actions/labeler@v6

.github/workflows/sync-labels.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
# monitoring configuration *does not* require you to modify
8585
# this workflow.
8686
permissions_monitoring_config: ${{ vars.ACTIONS_PERMISSIONS_CONFIG }}
87-
- uses: actions/checkout@v4
87+
- uses: actions/checkout@v5
8888
- name: Sync repository labels
8989
if: success()
9090
uses: crazy-max/ghaction-github-labeler@v5

.pre-commit-config.yaml

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
---
2+
ci:
3+
# Do not commit changes from running pre-commit for pull requests.
4+
autofix_prs: false
5+
# Autoupdate hooks weekly (this is the default).
6+
autoupdate_schedule: weekly
7+
28
default_language_version:
39
# force all unspecified python hooks to run python3
410
python: python3
@@ -10,7 +16,7 @@ repos:
1016
- id: check-useless-excludes
1117

1218
- repo: https://github.com/pre-commit/pre-commit-hooks
13-
rev: v5.0.0
19+
rev: v6.0.0
1420
hooks:
1521
- id: check-case-conflict
1622
- id: check-executables-have-shebangs
@@ -39,38 +45,38 @@ repos:
3945

4046
# Text file hooks
4147
- repo: https://github.com/igorshubovych/markdownlint-cli
42-
rev: v0.44.0
48+
rev: v0.45.0
4349
hooks:
4450
- id: markdownlint
4551
args:
4652
- --config=.mdl_config.yaml
4753
- repo: https://github.com/rbubley/mirrors-prettier
48-
rev: v3.5.3
54+
rev: v3.6.2
4955
hooks:
5056
- id: prettier
5157
- repo: https://github.com/adrienverge/yamllint
52-
rev: v1.37.0
58+
rev: v1.37.1
5359
hooks:
5460
- id: yamllint
5561
args:
5662
- --strict
5763

5864
# GitHub Actions hooks
5965
- repo: https://github.com/python-jsonschema/check-jsonschema
60-
rev: 0.32.1
66+
rev: 0.33.3
6167
hooks:
6268
- id: check-github-actions
6369
- id: check-github-workflows
6470

6571
# pre-commit hooks
6672
- repo: https://github.com/pre-commit/pre-commit
67-
rev: v4.2.0
73+
rev: v4.3.0
6874
hooks:
6975
- id: validate_manifest
7076

7177
# Go hooks
7278
- repo: https://github.com/TekWizely/pre-commit-golang
73-
rev: v1.0.0-rc.1
79+
rev: v1.0.0-rc.2
7480
hooks:
7581
# Go Build
7682
- id: go-build-repo-mod
@@ -99,7 +105,7 @@ repos:
99105

100106
# Shell script hooks
101107
- repo: https://github.com/scop/pre-commit-shfmt
102-
rev: v3.11.0-1
108+
rev: v3.12.0-2
103109
hooks:
104110
- id: shfmt
105111
args:
@@ -117,13 +123,13 @@ repos:
117123
# Redirect operators are followed by a space
118124
- --space-redirects
119125
- repo: https://github.com/shellcheck-py/shellcheck-py
120-
rev: v0.10.0.1
126+
rev: v0.11.0.1
121127
hooks:
122128
- id: shellcheck
123129

124130
# Python hooks
125131
- repo: https://github.com/PyCQA/bandit
126-
rev: 1.8.3
132+
rev: 1.8.6
127133
hooks:
128134
- id: bandit
129135
args:
@@ -133,7 +139,7 @@ repos:
133139
hooks:
134140
- id: black
135141
- repo: https://github.com/PyCQA/flake8
136-
rev: 7.1.2
142+
rev: 7.3.0
137143
hooks:
138144
- id: flake8
139145
additional_dependencies:
@@ -143,11 +149,11 @@ repos:
143149
hooks:
144150
- id: isort
145151
- repo: https://github.com/pre-commit/mirrors-mypy
146-
rev: v1.15.0
152+
rev: v1.18.1
147153
hooks:
148154
- id: mypy
149155
- repo: https://github.com/pypa/pip-audit
150-
rev: v2.8.0
156+
rev: v2.9.0
151157
hooks:
152158
- id: pip-audit
153159
args:
@@ -159,13 +165,13 @@ repos:
159165
- --requirement
160166
- requirements.txt
161167
- repo: https://github.com/asottile/pyupgrade
162-
rev: v3.19.1
168+
rev: v3.20.0
163169
hooks:
164170
- id: pyupgrade
165171

166172
# Ansible hooks
167173
- repo: https://github.com/ansible/ansible-lint
168-
rev: v25.4.0
174+
rev: v25.9.0
169175
hooks:
170176
- id: ansible-lint
171177
additional_dependencies:
@@ -209,7 +215,7 @@ repos:
209215

210216
# Terraform hooks
211217
- repo: https://github.com/antonbabenko/pre-commit-terraform
212-
rev: v1.98.0
218+
rev: v1.100.0
213219
hooks:
214220
- id: terraform_fmt
215221
- id: terraform_validate
@@ -222,7 +228,7 @@ repos:
222228

223229
# Packer hooks
224230
- repo: https://github.com/cisagov/pre-commit-packer
225-
rev: v0.3.0
231+
rev: v0.3.1
226232
hooks:
227233
- id: packer_fmt
228234
- id: packer_validate

CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,10 @@ you can begin to use `pyenv`.
132132
For a list of Python versions that are already installed and ready to
133133
use with `pyenv`, use the command `pyenv versions`. To see a list of
134134
the Python versions available to be installed and used with `pyenv`
135-
use the command `pyenv install --list`. You can read more
136-
[here](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md) about
137-
the many things that `pyenv` can do. See
138-
[here](https://github.com/pyenv/pyenv-virtualenv#usage) for the
139-
additional capabilities that pyenv-virtualenv adds to the `pyenv`
135+
use the command `pyenv install --list`. You can read more about
136+
the [many things that `pyenv` can do](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md).
137+
See the [usage information](https://github.com/pyenv/pyenv-virtualenv#usage)
138+
for the additional capabilities that pyenv-virtualenv adds to the `pyenv`
140139
command.
141140

142141
#### Creating the Python virtual environment ####

0 commit comments

Comments
 (0)