action.yml

name: 'alr install'
description: 'Install using `alr install`'
author: 'Alire Project'

inputs:
  crates:
    description: 'Crates to install, accepts version sets, e.g.: hello^2'
    required: true
    default: ''
  prefix:
    description: Location for the installation, will contain `<prefix>/bin` and so on
    required: false
    default: alire_prefix
  force:
    description: use `alr --force` during install
    required: false
    default: false
  add_to_path:
    description: Whether to add the prefix to path
    required: false
    default: true
  clean:
    description: Whether to remove alr afterwards, if it wasn't originally installed
    required: false
    default: true
  cache:
    description: Whether to reuse a cached previous install
    required: false
    default: true

outputs:
  cache_hit:
    description: Whether the cache was hit
    value: ${{ steps.cache-output.outputs.cache_hit }}

runs:
  using: "composite"
  steps:

    - name: Find alr in path
      id: find-alr
      shell: bash
      run: |
        which alr && echo "available=true" >> $GITHUB_OUTPUT || echo "available=false" >> $GITHUB_OUTPUT

    - name: Set up alr
      if: steps.find-alr.outputs.available != 'true'
      uses: alire-project/setup-alire@v4
      with:
        cache: ${{inputs.cache}}

    - name: Prepare alr version
      id: alr-version
      shell: bash
      run: |
        echo "version=$(alr --version)" >> $GITHUB_OUTPUT

    - name: Prepare --force
      id: force
      shell: bash
      run: |
        if [[ "${{inputs.force}}" != "false" ]]; then
          echo "force=--force" >> $GITHUB_OUTPUT
        else
          echo "force=" >> $GITHUB_OUTPUT
        fi

    - name: Prepare cache milestones
      id: find-versions
      shell: bash
      run: |
        versions=""
        for crate in ${{inputs.crates}}; do
          versions+=":"$(alr show ${crate} | head -1 | cut -f1 -d:)
        done
        echo Versions are: $versions
        echo "milestones=$versions" >> $GITHUB_OUTPUT

    - name: Prepare cache id
      id: cache-key
      shell: bash
      run: |
        echo "key=[2][alr-install][alr=${{steps.alr-version.outputs.version}}][${{runner.os}}][${{runner.arch}}][${{inputs.prefix}}][${{steps.find-versions.outputs.milestones}}]" >> $GITHUB_OUTPUT

    - name: Reuse cached installation
      if: inputs.cache == 'true'
      id: cache-install
      uses: actions/cache@v4
      with:
        path: |
          ${{inputs.prefix}}
        key: ${{steps.cache-key.outputs.key}}

    # In case of miss, give an explicit 'false' which actions/cache doesn't provide
    - name: Set cache_hit output
      id: cache-output
      shell: bash
      run: |
        if [[ "${{inputs.cache}}" == "true" && "${{steps.cache-install.outputs.cache-hit}}" == "true" ]]; then
          echo "cache_hit=true" >> $GITHUB_OUTPUT
        else
          echo "cache_hit=false" >> $GITHUB_OUTPUT
        fi

    - name: Diagnose cache usage
      shell: bash
      run: |
        echo "alr-install cache requested: ${{inputs.cache}}"
        echo "alr-install cache hit: ${{steps.cache-output.outputs.cache_hit}}"
        echo "alr-install cache key: ${{steps.cache-key.outputs.key}}"

    - name: Run `alr install`
      if: inputs.cache != 'true' || steps.cache-install.outputs.cache-hit != 'true'
      shell: bash
      run: |
        alr -d ${{steps.force.outputs.force}} install ${{inputs.crates}} --prefix ${{inputs.prefix}}

    - name: Show prefix info
      shell: bash
      run: |
        alr install --prefix ${{inputs.prefix}} --info

    - name: Add to path (Windows)
      if: inputs.add_to_path == 'true' && runner.os == 'Windows'
      shell: pwsh
      run: |
        $Target = Resolve-Path ${{inputs.prefix}}\bin
        Add-Content $env:GITHUB_PATH $Target

    - name: Add to path (!Windows)
      if: inputs.add_to_path == 'true' && runner.os != 'Windows'
      shell: bash
      run: |
        readlink -f "${{inputs.prefix}}/bin" >> $GITHUB_PATH

    - name: Cleanup
      if: inputs.clean == 'true' && steps.find-alr.outputs.available != 'true'
      shell: bash
      run: rm -rf alire_install

    # Save cache early so we can verify its proper working in a test workflow. Otherwise
    # it's not saved until workflow completion and by then it's too late.
    # When cache was hit, attempting to save will fail and emit a warning, so avoid it.
    - name: Cache save
      if: ${{ inputs.cache == 'true' && steps.cache-install.outputs.cache-hit != 'true' }}
      uses: actions/cache/save@v4
      with:
        path: |
          ${{inputs.prefix}}
        key: ${{steps.cache-key.outputs.key}}

    # Verify cache was saved properly
    - name: Cache verify
      if: ${{ inputs.cache == 'true' && steps.cache-install.outputs.cache-hit != 'true' }}
      uses: actions/cache/restore@v4
      with:
        path: |
          ${{inputs.prefix}}
        key: ${{steps.cache-key.outputs.key}}
        lookup-only: true
        fail-on-cache-miss: false
        # Even if the cache is not found, we don't want to fail here for clients