Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Bump default versions of Python, Node, Ruff, Terraform, Terragrunt #103

Merged
merged 1 commit into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ansible-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ name: python-linting
type: string
python_version:
description: The version of Python to use for the run.
default: '3.11'
default: '3.12'
required: false
type: string
timeout_minutes:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/conventional-commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
node-version: 23
- name: Install commitlint
run: |
npm install --save-dev @commitlint/{cli,config-conventional}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/python-deploy-to-pypi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ name: pypi_deploy
required: false
type: string
python_version:
default: '3.11'
default: '3.12'
description: The version of Python to use for the run.
required: false
type: string
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/python-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ name: python-linting
required: false
type: string
python_version:
default: '3.11'
default: '3.12'
description: The version of Python to use for the run.
required: false
type: string
ruff_version:
default: '0.1.0'
default: '0.8.1'
description: The version of ruff to run.
required: false
type: string
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/python-test-deploy-to-pypi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ name: pypi_test_deploy
type: string
python_version:
description: The version of Python to use for the run.
default: '3.11'
default: '3.12'
required: false
type: string
timeout_minutes:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/python-unit-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ name: Python Checks
required: false
type: string
python_versions:
default: '{ "versions": [ "3.9", "3.10", "3.11" ] }'
default: '{ "versions": [ "3.9", "3.10", "3.11", "3.12" ] }'
description: The versions of Python on which the unit tests should run.
required: false
type: string
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/terraform-validate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
required: false
type: string
terraform_version:
default: '1.5.5'
default: '1.10.0'
description: The version of Terraform to use when validating.
required: false
type: string
Expand All @@ -18,7 +18,7 @@
required: false
type: string
terragrunt_version:
default: '0.48.7'
default: '0.69.3'
description: The version of Terragrunt to use when validating.
required: false
type: string
Expand Down
53 changes: 28 additions & 25 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ command as part of their commits.

### ansible-lint.yaml

This workflow will setup [Python][5] (`3.11`) and lint the repository using both
This workflow will setup [Python][5] (`3.12`) and lint the repository using both
[yamllint][13] and [ansible-lint](https://github.com/ansible/ansible-lint). [Poetry][3]
is used to install the [Python][5] dependencies. Both [yamllint][13] and
[ansible-lint](https://github.com/ansible/ansible-lint) are expected to be installed by
Expand All @@ -34,21 +34,13 @@ the [Poetry][3] configuration in the repository using this workflow.

* `additional_packages`: String of additional packages that should be
installed. Default: ``
* `python_version`: The version of [Python][5] to use. Default: `3.11`
* `python_version`: The version of [Python][5] to use. Default: `3.12`

### conventional-commit.yaml
### close-stale.yaml

This workflow will run the[commitlint](https://commitlint.js.org/)
By default it only checks that PR titles follow [Conventional Commits][1].
In addition the 'subject-case' and 'body-max-line-length' checks are disabled.

* `validate_pr_title`: Validate PR title. Default: true
* `validate_current_commit`: Validate current commit (last commit). Default: false
* validate_pr_commits: Validate PR commits. Default: false

### Close Stale Issues and PRs

This workflow will close any issues or PRs that have been inactive for a certain amount of time. By default, this is set to 30 days. This workflow is based on the `actions/stale`.
This workflow will close any issues or PRs that have been inactive for a
certain amount of time. By default, this is set to 30 days. This workflow is
based on the `actions/stale`.

```yaml
---
Expand All @@ -62,6 +54,17 @@ jobs:
stale:
uses: broadinstitute/shared-workflows/.github/workflows/close-stale.yaml
```

### conventional-commit.yaml

This workflow will run the[commitlint](https://commitlint.js.org/)
By default it only checks that PR titles follow [Conventional Commits][1].
In addition the 'subject-case' and 'body-max-line-length' checks are disabled.

* `validate_pr_title`: Validate PR title. Default: true
* `validate_current_commit`: Validate current commit (last commit). Default: false
* validate_pr_commits: Validate PR commits. Default: false

### local-checks.yaml

These are local Actions that run for this repository. This workflow is not
Expand Down Expand Up @@ -125,7 +128,7 @@ This workflow will setup [Puppet][7] using
`3.2`). The linting and dependency installations will all happen using
[PDK][9].

#### puppet-linting Inputs
#### puppet-lint Inputs

* `puppet_version`: The version of [Puppet][7] to use in [PDK][9]. Default: `7`
* `ruby_version`: The version of [Ruby][8] to use. Default: `3.2`
Expand All @@ -150,7 +153,7 @@ tests will all happen using [PDK][9].

### python-deploy-to-pypi.yaml

This workflow will setup [Python][5] (`3.11`) and do a build and deploy of the
This workflow will setup [Python][5] (`3.12`) and do a build and deploy of the
[Python][5] package to [PyPi][2] using [Poetry][3].

#### python-deploy-to-pypi Inputs
Expand All @@ -159,7 +162,7 @@ This workflow will setup [Python][5] (`3.11`) and do a build and deploy of the
Default: ``
* `poetry_install_options`: Extra options to pass to Poetry when doing an install.
Default: `--no-root`
* `python_version`: The version of [Python][5] to use. Default: `3.11`
* `python_version`: The version of [Python][5] to use. Default: `3.12`

#### python-deploy-to-pypi Secrets

Expand All @@ -168,7 +171,7 @@ This workflow will setup [Python][5] (`3.11`) and do a build and deploy of the

### python-lint.yaml

This workflow will setup [Python][5] (`3.11`) and lint the repository.
This workflow will setup [Python][5] (`3.12`) and lint the repository.
[Poetry][3] is used to install any [Python][5] dependencies. By default the
linters run are [yamllint][13], and
[pylama](https://github.com/AtomLinter/linter-pylama). As of August 2023,
Expand All @@ -182,9 +185,9 @@ by setting the `use_ruff` input to `true`.
Default: ``
* `poetry_install_options`: Extra options to pass to Poetry when doing an install.
Default: `--no-root`
* `python_version`: The version of [Python][5] to use. Default: `3.11`
* `python_version`: The version of [Python][5] to use. Default: `3.12`
* `ruff_version`: The version of [Ruff](https://github.com/astral-sh/ruff) to
run. Default: `0.1.0`
run. Default: `0.8.1`
* `use_pylama`: If true, use
[pylama](https://github.com/AtomLinter/linter-pylama) to lint the repository.
Default: `true`
Expand All @@ -207,7 +210,7 @@ use `ubuntu-latest` for the base image.

### python-test-deploy-to-pypi.yaml

This workflow will setup [Python][5] (`3.11`) and do a build and deploy of the
This workflow will setup [Python][5] (`3.12`) and do a build and deploy of the
[Python][5] package to [Test PyPi][6] using [Poetry][3].

#### python-test-deploy-to-pypi Inputs
Expand All @@ -216,7 +219,7 @@ This workflow will setup [Python][5] (`3.11`) and do a build and deploy of the
Default: ``
* `poetry_install_options`: Extra options to pass to Poetry when doing an install.
Default: `--no-root`
* `python_version`: The version of [Python][5] to use. Default: `3.11`
* `python_version`: The version of [Python][5] to use. Default: `3.12`

#### python-test-deploy-to-pypi Secrets

Expand All @@ -239,7 +242,7 @@ install any [Python][5] dependencies.
create. Default: ``
* `python_versions`: The versions of [Python][5] to use in the unit tests, passed as a
string in JSON format with `versions` as the key. Default:
`'{ "versions": [ "3.7", "3.8", "3.9", "3.10", "3.11" ] }'`
`'{ "versions": [ "3.9", "3.10", "3.11", "3.12" ] }'`
* **Note: Make sure to enclose the JSON string in single quotes!!**
* `run_coverage`: Boolean to determine whether coverage should be run or not. Default:
`true`
Expand Down Expand Up @@ -315,11 +318,11 @@ check `terragrunt hclfmt` will also be run.
#### terraform-validate Inputs

* `terraform_version`: The version of Terraform to use when validating.
Default: `1.5.5`
Default: `1.10.0`
* `terragrunt_directory`: The environment directory from which Terragrunt
should run. Default: `prod`
* `terragrunt_version`: The version of Terragrunt to use when validating.
Default: `0.48.7`
Default: `0.69.3`
* `use_terragrunt`: If set to true, use Terragrunt instead of Terraform.
Default: `false`

Expand Down
Loading