diff --git a/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml b/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml index 3bc192c5..c4d0fb94 100644 --- a/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml +++ b/.github/workflows/_reusable-update-python-and-pre-commit-dependencies.yml @@ -37,7 +37,7 @@ on: required: false type: string default: '' - pre-commit-hook-run-skip-list: + pre-commit-hook-skip-list: description: A comma-separated list of pre-commit hooks to skip (only applicable when `run-pre-commit=true`). required: false @@ -96,7 +96,7 @@ jobs: update-pre-commit: ${{ inputs.update-pre-commit }} run-pre-commit: ${{ inputs.run-pre-commit }} pre-commit-repo-update-skip-list: ${{ inputs.pre-commit-repo-update-skip-list }} - pre-commit-hook-run-skip-list: ${{ inputs.pre-commit-hook-run-skip-list }} + pre-commit-hook-skip-list: ${{ inputs.pre-commit-hook-skip-list }} export-dependency-groups: ${{ inputs.export-dependency-groups }} - if: ${{ !endsWith(github.repository, '/python-package-ci-cd') }} # Run the public action when this is run outside the python-package-ci-cd repository uses: tektronix/python-package-ci-cd/actions/update_development_dependencies@v1.4.1 @@ -105,7 +105,7 @@ jobs: update-pre-commit: ${{ inputs.update-pre-commit }} run-pre-commit: ${{ inputs.run-pre-commit }} pre-commit-repo-update-skip-list: ${{ inputs.pre-commit-repo-update-skip-list }} - pre-commit-hook-run-skip-list: ${{ inputs.pre-commit-hook-run-skip-list }} + pre-commit-hook-skip-list: ${{ inputs.pre-commit-hook-skip-list }} export-dependency-groups: ${{ inputs.export-dependency-groups }} - uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1 with: diff --git a/.github/workflows/test-actions.yml b/.github/workflows/test-actions.yml index 7cc92b0a..3f9efe68 100644 --- a/.github/workflows/test-actions.yml +++ b/.github/workflows/test-actions.yml @@ -151,7 +151,7 @@ jobs: run-pre-commit: true dependency-dict: '{"dev": ["pyright"]}' pre-commit-repo-update-skip-list: https://github.com/pre-commit/pre-commit-hooks,https://github.com/executablebooks/mdformat - pre-commit-hook-run-skip-list: remove-tabs,forbid-tabs,check-readthedocs,check-dependabot,check-github-actions,check-github-workflows,commitizen,blacken-docs,yamlfix,hadolint,mdformat,markdown-link-check,check-poetry,toml-sort-fix,pyright,poetry-audit,ruff,ruff-format,docformatter,renovate-config-validator,actionlint + pre-commit-hook-skip-list: remove-tabs,forbid-tabs,check-readthedocs,check-dependabot,check-github-actions,check-github-workflows,commitizen,blacken-docs,yamlfix,hadolint,mdformat,markdown-link-check,check-poetry,toml-sort-fix,pyright,poetry-audit,ruff,ruff-format,docformatter,renovate-config-validator,actionlint export-dependency-groups: | actions-update_development_dependencies:actions/update_development_dependencies, tests diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d2ef03a..447a3112 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,6 @@ Things to be included in the next release go here. ### Changed - Bumped dependency versions. -- _**BREAKING CHANGE**_: Renamed the `pre-commit-hook-skip-list` input parameter to `pre-commit-hook-run-skip-list` in the `_reusable-update-python-and-pre-commit-dependencies.yml` workflow and `update_development_dependencies` action. --- diff --git a/actions/update_development_dependencies/action.yml b/actions/update_development_dependencies/action.yml index 8ed484f5..5161081e 100644 --- a/actions/update_development_dependencies/action.yml +++ b/actions/update_development_dependencies/action.yml @@ -34,7 +34,7 @@ inputs: (only applicable when `update-pre-commit=true`). required: false default: '' - pre-commit-hook-run-skip-list: + pre-commit-hook-skip-list: description: A comma-separated list of pre-commit hooks to skip (only applicable when `run-pre-commit=true`). required: false diff --git a/actions/update_development_dependencies/main.py b/actions/update_development_dependencies/main.py index e5cd8df8..644df5ca 100644 --- a/actions/update_development_dependencies/main.py +++ b/actions/update_development_dependencies/main.py @@ -226,7 +226,7 @@ def main() -> None: export_dependency_groups = [ x.strip() for x in os.environ["INPUT_EXPORT-DEPENDENCY-GROUPS"].split(",") if x ] - pre_commit_hook_run_skip_list = os.environ["INPUT_PRE-COMMIT-HOOK-RUN-SKIP-LIST"] + pre_commit_hook_run_skip_list = os.environ["INPUT_PRE-COMMIT-HOOK-SKIP-LIST"] pre_commit_repo_update_skip_list = [ x.strip() for x in os.environ["INPUT_PRE-COMMIT-REPO-UPDATE-SKIP-LIST"].split(",") if x ] diff --git a/actions/update_development_dependencies/readme.md b/actions/update_development_dependencies/readme.md index f5f194ee..d3e201b0 100644 --- a/actions/update_development_dependencies/readme.md +++ b/actions/update_development_dependencies/readme.md @@ -28,7 +28,7 @@ This action enables updating Python development dependencies using the | `update-pre-commit` | optional | A boolean indicating if the pre-commit hooks should be updated. | `false` | | `run-pre-commit` | optional | A boolean indicating to run the pre-commit hooks to perform auto-fixing after updating the dependencies. Setting this input to `true` will also set the update-pre-commit input to `true`. | `false` | | `pre-commit-repo-update-skip-list` | optional | A comma-separated list of pre-commit repo urls to skip updates for (only applicable when `update-pre-commit=true`). | `""` | -| `pre-commit-hook-run-skip-list` | optional | A comma-separated list of pre-commit hooks to skip (only applicable when `run-pre-commit=true`). | `""` | +| `pre-commit-hook-skip-list` | optional | A comma-separated list of pre-commit hooks to skip (only applicable when `run-pre-commit=true`). | `""` | | `export-dependency-groups` | optional | A comma-separated list of dependency groups to export to a `requirements.txt` file. The format is `group1,group2:custom-path/to/test/folder`. | `""` | ## Example @@ -55,7 +55,7 @@ jobs: update-pre-commit: true # optional run-pre-commit: true # optional pre-commit-repo-update-skip-list: 'https://github.com/pre-commit/pre-commit-hooks' # optional - pre-commit-hook-run-skip-list: 'pylint' # optional, hooks that don't auto-fix things can (and probably should be) skipped + pre-commit-hook-skip-list: 'pylint' # optional, hooks that don't auto-fix things can (and probably should be) skipped export-dependency-groups: 'docs,tests:custom-path/to/test/folder' # optional - uses: stefanzweifel/git-auto-commit-action@v5 diff --git a/tests/test_update_development_dependencies.py b/tests/test_update_development_dependencies.py index d5f7327f..a5d05149 100644 --- a/tests/test_update_development_dependencies.py +++ b/tests/test_update_development_dependencies.py @@ -144,7 +144,7 @@ def fixture_repo_root_dir( monkeypatch.setenv( "INPUT_PRE-COMMIT-REPO-UPDATE-SKIP-LIST", ",".join(PRE_COMMIT_REPO_UPDATE_SKIP_LIST) ) - monkeypatch.setenv("INPUT_PRE-COMMIT-HOOK-RUN-SKIP-LIST", "") + monkeypatch.setenv("INPUT_PRE-COMMIT-HOOK-SKIP-LIST", "") monkeypatch.setenv("INPUT_INSTALL-DEPENDENCIES", "true") monkeypatch.setenv("INPUT_RUN-PRE-COMMIT", "true") monkeypatch.setenv("INPUT_UPDATE-PRE-COMMIT", "true") diff --git a/workflows/update-python-and-pre-commit-dependencies.md b/workflows/update-python-and-pre-commit-dependencies.md index 419b4952..df534739 100644 --- a/workflows/update-python-and-pre-commit-dependencies.md +++ b/workflows/update-python-and-pre-commit-dependencies.md @@ -37,7 +37,7 @@ updates for the Python dependencies. | `update-pre-commit` | optional | A boolean indicating if the pre-commit hooks should be updated. | `false` | | `run-pre-commit` | optional | A boolean indicating to run the pre-commit hooks to perform auto-fixing after updating the dependencies. Setting this input to `true` will also set the update-pre-commit input to `true`. | `false` | | `pre-commit-repo-update-skip-list` | optional | A comma-separated list of pre-commit repo urls to skip updates for (only applicable when `update-pre-commit=true`). | `""` | -| `pre-commit-hook-run-skip-list` | optional | A comma-separated list of pre-commit hooks to skip (only applicable when `run-pre-commit=true`). | `""` | +| `pre-commit-hook-skip-list` | optional | A comma-separated list of pre-commit hooks to skip (only applicable when `run-pre-commit=true`). | `""` | | `export-dependency-groups` | optional | A comma-separated list of dependency groups to export to a `requirements.txt` file. The format is `group1,group2:custom-path/to/test/folder`. | `""` | ## Secrets @@ -66,7 +66,7 @@ jobs: update-pre-commit: true # optional run-pre-commit: true # optional pre-commit-repo-update-skip-list: 'https://github.com/pre-commit/pre-commit-hooks' # optional - pre-commit-hook-run-skip-list: pylint,pyright,pyroma,poetry-audit # optional, hooks that don't auto-fix things can (and probably should be) skipped + pre-commit-hook-skip-list: pylint,pyright,pyroma,poetry-audit # optional, hooks that don't auto-fix things can (and probably should be) skipped export-dependency-groups: 'docs,tests:custom-path/to/test/folder' # optional permissions: contents: write