feat: add Windows runner support (#99)

Change `${{ github.action_path }}` to `${GITHUB_ACTION_PATH}` to add
support for Windows runners

Add a functional test on a Windows runner

Closes #75

.github/workflows/functional_tests.yml

@@ -61,7 +61,7 @@ jobs:
       - uses: ./.github/functional_tests/auto_config_false
         with:
           toolchain: ${{ env.toolchain }}
-  
+
   detect-mathlib:
     runs-on: ubuntu-latest
     steps:
@@ -117,7 +117,7 @@ jobs:
       - uses: ./.github/functional_tests/subdirectory_lake_package
         with:
           toolchain: ${{ env.toolchain }}
-  
+
   macos-runner:
     runs-on: macos-latest
     steps:
@@ -127,3 +127,12 @@ jobs:
           lake-init-arguments: "standalone"
           toolchain: ${{ env.toolchain }}
 
+  windows-runner:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/functional_tests/lake_init_success
+        with:
+          lake-init-arguments: "standalone"
+          toolchain: ${{ env.toolchain }}
+

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Windows GitHub runner support
+
 ### Fixed
 
 - replace `actions/cache` with `actions/cache/restore` to prevent redundant cache saving

README.md

@@ -27,9 +27,9 @@ jobs:
 ```
 
 > [!IMPORTANT]
-`lean-action` is tested on `ubuntu-latest` and `macos-latest` GitHub-hosted runners,
-and should support Unix-based runners in general.
-Currently, `lean-action` does not support Windows runners.
+`lean-action` is tested on `ubuntu-latest`, `macos-latest`, and `windows-latest` GitHub-hosted runners.
+We recommend using one of these runners for the best experience,
+however if you encounter an issue when using a different runner, please still open an issue.
 
 ## Configuring which features `lean-action` runs
 

action.yml

@@ -112,7 +112,7 @@ runs:
     - name: install elan
       run: |
         : Install Elan
-        ${{ github.action_path }}/scripts/install_elan.sh
+        ${GITHUB_ACTION_PATH}/scripts/install_elan.sh
       shell: bash
       working-directory: ${{ inputs.lake-package-directory }}
 
@@ -125,7 +125,7 @@ runs:
         LINT: ${{ inputs.lint }}
       run: |
         : Configure Lean Action
-        ${{ github.action_path }}/scripts/config.sh
+        ${GITHUB_ACTION_PATH}/scripts/config.sh
       shell: bash
       working-directory: ${{ inputs.lake-package-directory }}
 
@@ -143,7 +143,7 @@ runs:
       id: detect-mathlib
       run: |
         : Detect Mathlib
-        ${{ github.action_path }}/scripts/detect_mathlib.sh
+        ${GITHUB_ACTION_PATH}/scripts/detect_mathlib.sh
       shell: bash
       working-directory: ${{ inputs.lake-package-directory }}
 
@@ -166,7 +166,7 @@ runs:
           BUILD_ARGS: ${{ inputs.build-args }}
       run: |
         : Lake Build
-        ${{ github.action_path }}/scripts/lake_build.sh
+        ${GITHUB_ACTION_PATH}/scripts/lake_build.sh
       shell: bash
       working-directory: ${{ inputs.lake-package-directory }}
 
@@ -181,7 +181,7 @@ runs:
       if: ${{ steps.config.outputs.run-lake-test == 'true'}}
       run: |
         : Lake Test
-        ${{ github.action_path }}/scripts/lake_test.sh
+        ${GITHUB_ACTION_PATH}/scripts/lake_test.sh
       shell: bash
       working-directory: ${{ inputs.lake-package-directory }}
 
@@ -191,7 +191,7 @@ runs:
       if: ${{ steps.config.outputs.run-lake-lint == 'true'}}
       run: |
         : Lake Lint
-        ${{ github.action_path }}/scripts/lake_lint.sh
+        ${GITHUB_ACTION_PATH}/scripts/lake_lint.sh
       shell: bash
       working-directory: ${{ inputs.lake-package-directory }}
 
@@ -200,7 +200,7 @@ runs:
       # Passes in the private status, number of stars, and license id of the repository to check_reservoir_eligibility.sh script
       run: |
         : Check Reservoir Eligibility
-        ${{ github.action_path }}/scripts/check_reservoir_eligibility.sh \
+        ${GITHUB_ACTION_PATH}/scripts/check_reservoir_eligibility.sh \
           "${{ github.event.repository.private }}"\
           "${{ github.event.repository.stargazers_count }}"\
           "${{ github.event.repository.license.spdx_id }}"
@@ -211,6 +211,6 @@ runs:
       if: ${{ inputs.lean4checker == 'true' }}
       run: |
         : Check Environment with lean4checker
-        ${{ github.action_path }}/scripts/run_lean4checker.sh
+        ${GITHUB_ACTION_PATH}/scripts/run_lean4checker.sh
       shell: bash
       working-directory: ${{ inputs.lake-package-directory }}