setup-cz/action.yaml at main · commitizen-tools/setup-cz · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
name: Setup commitizen CLI
description: Github action to only configure cz CLI

inputs:
  version:
    description: "Version of commitizen to install"
    required: false
    default: "latest"
  extra-requirements:
    description: "Install extra dependencies"
    required: false
  extra_requirements:
    description: "DEPRECATED, use `extra-requirements` instead. Install extra dependencies"
    required: false
  python-version:
    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"
    required: false
  set-git-config:
    description: "Set git config"
    required: false
    default: "true"
  git-user-name:
    description: "Git user name"
    required: false
    default: "github-actions[bot]"
  git-user-email:
    description: "Git user email"
    required: false
    default: "41898282+github-actions[bot]@users.noreply.github.com"

branding:
  icon: "anchor"
  color: "purple"

runs:
  using: "composite"
  steps:
    - if: ${{ inputs.set-git-config == 'true' }}
      shell: bash
      run: |
        git config --global user.name "${{ inputs.git-user-name }}"
        git config --global user.email "${{ inputs.git-user-email }}"
    - id: set-vars
      uses: actions/github-script@v8
      env:
        COMMITIZEN_VERSION: ${{ inputs.version }}
        CACHE: ${{ inputs.cache }}
      with:
        script: |
          // Set commitizen version
          const commitizenVersion = process.env.COMMITIZEN_VERSION || '';
          const setCommitizenVersion = commitizenVersion === 'latest' ? '' : `==${commitizenVersion}`;

          // Write outputs
          core.setOutput('commitizen-version', setCommitizenVersion);
    - uses: actions/setup-python@v6
      with:
        python-version: ${{ inputs.python-version }}
    - name: Check for deprecated input
      shell: bash
      if: ${{ inputs.extra_requirements && !inputs.extra-requirements }}
      run: echo "::warning::The 'extra_requirements' input is deprecated. Please use 'extra-requirements' instead. It will be removed in v1"
    - name: Install commitizen
      shell: bash
      env:
        COMMITIZEN_VERSION: ${{ steps.set-vars.outputs.commitizen-version }}
        EXTRA_REQUIREMENTS: ${{ inputs.extra-requirements || inputs.extra_requirements }}
      run: |
        python -m pip install -U commitizen${COMMITIZEN_VERSION} ${EXTRA_REQUIREMENTS}