action.yml

name: "Sourcery Action"

branding:
  icon: 'box'
  color: 'orange'

description: "A GitHub Action for running Sourcery."

inputs:
  token:
    description: >
      The Sourcery token for logging in.

      The Sourcery token can be retrieved from 
      [your dashboard](https://sourcery.ai/dashboard/profile) and uploaded to your
      GitHub repository as a 
      [GitHub secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
    required: true
  target:
    description: "File(s) or directory(ies) to review."
    required: false
    default: "."
  version:
    description: >
      Sourcery CLI version, e.g. '1.5.0'. If empty, default to the latest version 
      available.
    required: false
    default: ""
  verbose:
    description: >
      Verbose output with explanation and code snippets. Either 'true' or 'false'.
    required: false
    default: "true"
  check:
    description: "Fail job if issues are found. Either 'true' or 'false'."
    required: false
    default: "true"
  fix:
    description: "Automatically fix issues where possible. Either 'true' or 'false'."
    required: false
    default: "false"
  in_place:
    description: "Change files in place. Either 'true' or 'false'."
    required: false
    default: "false"
    deprecationMessage: >
      This input is deprecated and will be removed in a future release. Please update 
      your Sourcery `version` and use `fix` instead of `in_place`.
  config:
    description: "Location of the Sourcery YAML configuration file."
    required: false
    default: ""
  diff_ref:
    description: >
      Reference to compare the current branch with and run Sourcery on the diff.
      If empty, run Sourcery on the entire codebase.
      To review only code that changed in a PR, use
      "github.event.pull_request.base.sha".
    required: false
    default: ""

runs:
  using: composite
  steps:
    - name: Install Sourcery
      shell: bash
      run: |
        if [ -z ${{ inputs.version }} ]
        then
          python3 -m pip install sourcery
        else
          python3 -m pip install sourcery==${{ inputs.version }}
        fi

    - name: Authenticate Sourcery
      shell: bash
      run: |
        sourcery login --token ${{ inputs.token }}

    - name: Sourcery review
      shell: bash
      run: |
        if [ ${{ inputs.check }} == "true" ]; then
          SOURCERY_OPTIONS+=( "--check" )
        elif [ ${{ inputs.check }} != "false" ]; then
          echo "Invalid value for input 'check'"
          echo "Expected either 'true' or 'false'"
          echo "Got '${{ inputs.check }}'"
          exit 1
        fi

        if [ ${{ inputs.fix }} == "true" ]; then
          SOURCERY_OPTIONS+=( "--fix" )
        elif [ ${{ inputs.fix }} != "false" ]; then
          echo "Invalid value for input 'fix'"
          echo "Expected either 'true' or 'false'"
          echo "Got '${{ inputs.fix }}'"
          exit 1
        fi

        # this input is deprecated and will be removed in a future release
        # we are keeping it here because users might have pinned Sourcery to an older
        # version that does not support `--fix`
        if [ ${{ inputs.in_place }} == "true" ]; then
          SOURCERY_OPTIONS+=( "--in-place" )
        elif [ ${{ inputs.in_place }} != "false" ]; then
          echo "Invalid value for input 'in_place'"
          echo "Expected either 'true' or 'false'"
          echo "Got '${{ inputs.in_place }}'"
          exit 1
        fi

        if [ ${{ inputs.verbose }} == "true" ]; then
          SOURCERY_OPTIONS+=( "--verbose" )
        elif [ ${{ inputs.verbose }} != "false" ]; then
          echo "Invalid value for input 'verbose'"
          echo "Expected either 'true' or 'false'"
          echo "Got '${{ inputs.verbose }}'"
          exit 1
        fi

        if [ -n "${{ inputs.config }}" ]; then
          SOURCERY_OPTIONS+=( "--config ${{ inputs.config }}" )
        fi

        if [ -n "${{ inputs.diff_ref }}" ]; then
          SOURCERY_OPTIONS+=( "--diff=git diff ${{ inputs.diff_ref }}" )
        fi

        sourcery review "${SOURCERY_OPTIONS[@]}" ${{ inputs.target }}