action.yml

name: Changelogs generated with git-cliff
description:  Generate Changelog with a customized template 
author: tj-actions
inputs:
  args:
    description: "Extra args passed directly to [git-cliff](https://github.com/orhun/git-cliff#command-line-arguments)"
    required: false
    default: "--verbose"
  output:
    description: "Output file"
    required: false
    default: "HISTORY.md"
  template-config:
    description: "Path or URL to the template `cliff.toml` config file. See [`cliff-template.toml`](./cliff-template.toml) for a working example. **NOTE:** Only the `REPOSITORY_URL` is substituted."
    required: false
  git-cliff-version:
    description: "Provide the version for git-cliff. e.g latest, v2.10.0"
    required: false
    default: "latest"
  token:
    description: 'GITHUB_TOKEN or a Repo scoped PAT'
    required: false
    default: ${{ github.token }}

runs:
  using: 'composite'
  steps:
    - run: |
        bash $GITHUB_ACTION_PATH/entrypoint.sh
      id: git-cliff
      shell: bash
      env:
        # INPUT_<VARIABLE_NAME> is not available in Composite run steps
        # https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#example-specifying-inputs
        INPUT_REPOSITORY_URL: ${{ github.server_url }}/${{ github.repository }}
        INPUT_TEMPLATE_CONFIG: ${{ inputs.template-config }}

    - name: Install git-cliff
      id: install-git-cliff
      uses: tj-actions/setup-bin@v1.2.3
      with:
        token: ${{ inputs.token }}
        repository-owner: orhun
        repository: git-cliff
        language-type: rust
        add-prefix-to-version: false
        version: ${{ inputs.git-cliff-version }}

    - name: Generate a changelog
      shell: bash
      run: |
        ${{ steps.install-git-cliff.outputs.binary_path }} --config "${{ steps.git-cliff.outputs.output_path }}" \
          --output "${{ inputs.output }}" \
          ${{ inputs.args }}
        
    - name: Cleanup
      shell: bash
      run: |
        bash $GITHUB_ACTION_PATH/cleanup.sh
      env:
        INPUT_OUTPUT_PATH: ${{ steps.git-cliff.outputs.output_path }}
branding:
  icon: check-square
  color: white