action.yaml

name: 'Looker Janitor: LookML View Cleaner'
description: Tidy up Looker LookML view files by grouping, sorting and warning about inconsistencies.
author: 'Alhan Keser'

inputs:
  files:
    required: false
    type: string
    description: 'List of files to clean. If omitted, then any changed view files will be cleaned.'
    default: ''
  type_order:
    required: false
    type: string
    description: 'Order of field types.'
    default: |
      filter
      parameter
      dimension
      dimension_group
      measure
      set
  param_order:
    required: false
    type: string
    description: 'Order of field parameters.'
    default: |
      hidden
      type
      view_label
      group_label
      group_item_label
      label
      description
      sql
      sql_start
      sql_end
      filters
      value_format_name
      value_format
      drill_fields
  primary_key_first:
    required: false
    type: boolean
    description: 'Should primary key be ordered first.'
    default: true
  order_types:
    required: false
    type: boolean
    description: 'Should fields be ordered by their type.'
    default: true
  order_fields:
    required: false
    type: boolean
    description: 'Should fields be ordered.'
    default: true
  order_field_parameters:
    required: false
    type: boolean
    description: 'Should field parameters be ordered.'
    default: true
  order_fields_by_label:
    required: false
    type: boolean
    description: 'Should fields be ordered by their labels.'
    default: true
  localization_file_path:
    required: false
    type: string
    description: 'Localization file path to use for label sorting'
    default: 'None'
  check_required_params:
    required: false
    type: boolean
    description: 'Should required parameters be checked.'
    default: false
  required_filter:
    required: false
    type: string
    description: 'List of required filter parameters.'
    default: |
      type
  required_parameter:
    required: false
    type: string
    description: 'List of required parameter parameters.'
    default: |
      type
  required_dimension:
    required: false
    type: string
    description: 'List of required dimension parameters.'
    default: |
      type
  required_dimension_group:
    required: false
    type: string
    description: 'List of required dimension_group parameters.'
    default: |
      type
  required_measure:
    required: false
    type: string
    description: 'List of required measure parameters.'
    default: |
      type
  required_set:
    required: false
    type: string
    description: 'List of required filter parameters.'
    default: |
      fields

runs:
  using: 'composite'
  steps:
    - name: Checkout Branch
      uses: actions/checkout@v2
      with:
        ref: ${{ github.event.pull_request.head.ref }}
    - name: Configure Git user
      run : |
        git config user.name github-actions
        git config user.email github-actions@github.com
      shell: bash
    - name: Checkout Looker Janitor
      uses: actions/checkout@v2
      with:
        repository: alhankeser/looker-janitor
        path: looker-janitor
        ref: v0
    - name: Install Python
      uses: actions/setup-python@v2
      with:
        python-version: 3.12
    - name: Install Dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r looker-janitor/requirements.txt
      shell: bash
    - name: Get Changed Files
      if: ${{ inputs.files == '' }}
      id: changed_files
      uses: tj-actions/changed-files@v44
      with:
        files: |
            **.view.lkml
            **.view.lookml
    - name: Get Looker Janitor Arguments
      id: janitor_args
      run: |
        if [ "${{ inputs.files }}" != "" ]; then
          files="${{ inputs.files }}"
        else
          files="${{ steps.changed_files.outputs.all_changed_files }}"
        fi
        echo "files=${files//$'\n'/ }" >> $GITHUB_OUTPUT
        
        type_order="${{ inputs.type_order }}"
        param_order="${{ inputs.param_order }}"
        primary_key_first="${{ inputs.primary_key_first }}"
        order_types="${{ inputs.order_types }}"
        order_fields="${{ inputs.order_fields }}"
        order_field_parameters="${{ inputs.order_field_parameters }}"
        order_fields_by_label="${{ inputs.order_fields_by_label }}"
        localization_file_path="${{ inputs.localization_file_path }}"
        check_required_params="${{ inputs.check_required_params }}"
        required_filter="${{ inputs.required_filter }}"
        required_parameter="${{ inputs.required_parameter }}"
        required_dimension="${{ inputs.required_dimension }}"
        required_dimension_group="${{ inputs.required_dimension_group }}"
        required_measure="${{ inputs.required_measure }}"
        required_set="${{ inputs.required_set }}"

        echo "type_order=${type_order//$'\n'/ }" >> $GITHUB_OUTPUT
        echo "param_order=${param_order//$'\n'/ }" >> $GITHUB_OUTPUT
        echo "primary_key_first=${primary_key_first}" >> $GITHUB_OUTPUT
        echo "order_types=${order_types}" >> $GITHUB_OUTPUT
        echo "order_fields=${order_fields}" >> $GITHUB_OUTPUT
        echo "order_field_parameters=${order_field_parameters}" >> $GITHUB_OUTPUT
        echo "order_fields_by_label=${order_fields_by_label}" >> $GITHUB_OUTPUT
        echo "localization_file_path=${localization_file_path}" >> $GITHUB_OUTPUT
        echo "check_required_params=${check_required_params}" >> $GITHUB_OUTPUT
        echo "required_filter=${required_filter//$'\n'/ }" >> $GITHUB_OUTPUT
        echo "required_parameter=${required_parameter//$'\n'/ }" >> $GITHUB_OUTPUT
        echo "required_dimension=${required_dimension//$'\n'/ }" >> $GITHUB_OUTPUT
        echo "required_dimension_group=${required_dimension_group//$'\n'/ }" >> $GITHUB_OUTPUT
        echo "required_measure=${required_measure//$'\n'/ }" >> $GITHUB_OUTPUT
        echo "required_set=${required_set//$'\n'/ }" >> $GITHUB_OUTPUT
      shell: bash
    - name: Check Files
      id: has_files_check
      shell: bash
      run: |
        if [ "${{ steps.janitor_args.outputs.files }}" == "" ]; then
          echo "has_files=false" >> $GITHUB_OUTPUT
        else
          echo "has_files=true" >> $GITHUB_OUTPUT
        fi
    - name: Run Looker Janitor
      id: looker_janitor
      if: ${{ steps.has_files_check.outputs.has_files == 'true' }}
      run: |
        python looker-janitor/main.py \
        --files ${{ steps.janitor_args.outputs.files }} \
        --type_order ${{ steps.janitor_args.outputs.type_order }} \
        --param_order ${{ steps.janitor_args.outputs.param_order }} \
        --primary_key_first ${{ steps.janitor_args.outputs.primary_key_first }} \
        --order_types ${{ steps.janitor_args.outputs.order_types }} \
        --order_fields ${{ steps.janitor_args.outputs.order_fields }} \
        --order_field_parameters ${{ steps.janitor_args.outputs.order_field_parameters }} \
        --order_fields_by_label ${{ steps.janitor_args.outputs.order_fields_by_label }} \
        --localization_file_path ${{ steps.janitor_args.outputs.localization_file_path }} \
        --check_required_params ${{ steps.janitor_args.outputs.check_required_params }} \
        --required_filter ${{ steps.janitor_args.outputs.required_filter }} \
        --required_parameter ${{ steps.janitor_args.outputs.required_parameter }} \
        --required_dimension ${{ steps.janitor_args.outputs.required_dimension }} \
        --required_dimension_group ${{ steps.janitor_args.outputs.required_dimension_group }} \
        --required_measure ${{ steps.janitor_args.outputs.required_measure }} \
        --required_set ${{ steps.janitor_args.outputs.required_set }} >> looker-janitor/output.txt
      shell: bash

branding:
  icon: check-circle
  color: purple