Skip to content

Commit 559efcb

Browse files
committed
fix(input): rename extra requirements to kebab case
BREAKING CHANGE: Input `extra_requirements` has been renamed to `extra-requirement` to follow github actions conventions. The camel case version will be removed in v1
1 parent 118548d commit 559efcb

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

.github/workflows/test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
- uses: actions/checkout@v6
4545
- uses: ./
4646
with:
47-
extra_requirements: ${{ matrix.extra_requirements.pip_name }}
47+
extra-requirements: ${{ matrix.extra_requirements.pip_name }}
4848
- name: Test extra requirements were installed
4949
uses: actions/github-script@v8
5050
env:

action.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ inputs:
66
description: "Version of commitizen to install"
77
required: false
88
default: "latest"
9-
extra_requirements:
9+
extra-requirements:
1010
description: "Install extra dependencies"
1111
required: false
12+
extra_requirements:
13+
description: "DEPRECATED, use `extra-requirements` instead. Install extra dependencies"
14+
required: false
1215
python-version:
1316
description: "Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset. Passed directly to setup-python"
1417
required: false
@@ -45,10 +48,13 @@ runs:
4548
- uses: actions/setup-python@v6
4649
with:
4750
python-version: ${{ inputs.python-version }}
51+
- name: Check for deprecated input
52+
if: ${{ inputs.extra_requirements && !inputs.extra-requirements }}
53+
run: echo "::warning::The 'extra_requirements' input is deprecated. Please use 'extra-requirements' instead. It will be removed in v1"
4854
- name: Install commitizen
4955
shell: bash
5056
env:
5157
COMMITIZEN_VERSION: ${{ steps.set-vars.outputs.commitizen-version }}
52-
EXTRA_REQUIREMENTS: ${{ inputs.extra_requirements }}
58+
EXTRA_REQUIREMENTS: ${{ inputs.extra-requirements || inputs.extra_requirements }}
5359
run: |
5460
python -m pip install -U commitizen${COMMITIZEN_VERSION} ${EXTRA_REQUIREMENTS}

0 commit comments

Comments
 (0)