Merge branch 'main' into dpa/using

Author: IanButterworth

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 100
+    labels:
+      - "dependencies"
+      - "github-actions"

.github/workflows/Invalidations.yml

@@ -0,0 +1,52 @@
+name: Example
+
+on:
+  pull_request:
+
+# defaults:
+  # run:
+    # working-directory: ./ci/
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: always.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  example:
+    # Only run on PRs to the default branch.
+    # In the PR trigger above branches can be specified only explicitly whereas this check should work for master, main, or any other default branch
+    # if: github.base_ref == github.event.repository.default_branch
+    runs-on: ubuntu-latest
+    steps:
+    - uses: julia-actions/setup-julia@v2
+      with:
+        version: '1'
+    - uses: actions/checkout@v3
+    - run: |
+        import Pkg
+        p = Pkg.PackageSpec(name = "Example", version = "0.5", uuid = "7876af07-990d-54b4-ab0e-23690620f79a")
+        Pkg.add(p)
+      shell: julia {0}
+    # - uses: julia-actions/julia-invalidations@v1
+    - uses: ./
+      id: invs_pro
+      with:
+        test_script: 'import Example'
+        package_name: 'Example'
+
+    # - uses: julia-actions/julia-invalidations@v1
+    - uses: ./
+      id: invs_default
+      with:
+        test_script: 'import Example'
+        package_name: 'Example'
+
+    - name: Report invalidation counts
+      run: |
+        echo "Invalidations on default branch: ${{ steps.invs_default.outputs.total }} (${{ steps.invs_default.outputs.deps }} via deps)" >> $GITHUB_STEP_SUMMARY
+        echo "This branch: ${{ steps.invs_pr.outputs.total }} (${{ steps.invs_pr.outputs.deps }} via deps)" >> $GITHUB_STEP_SUMMARY
+    - name: Check if the PR does increase number of invalidations
+      if: steps.invs_pr.outputs.total > steps.invs_default.outputs.total
+      run: exit 1

README.md

@@ -1,6 +1,9 @@
 # julia-invalidations
-Uses [`SnoopCompile.@snoopr`](https://timholy.github.io/SnoopCompile.jl/stable/snoopr/)
-to evaluate number of invalidations caused by `using Package` or a provided script
+Uses [`SnoopCompile.@snoopr`](https://timholy.github.io/SnoopCompile.jl/v2/snoopr/)
+to evaluate number of invalidations caused by `using Package` or a provided script.
+
+Currently this action uses SnoopCompile v2.
+In a future release, we will upgrade to SnoopCompile v3.
 
 
 ## Usage

action.yml

@@ -6,6 +6,16 @@ inputs:
     description: 'Script to test for invalidations. Defaults to `import Package`'
     required: false
     default: ''
+  package_name:
+    description: 'Name of the package. By default, tries to auto-detect from the repo name.'
+    required: false
+    default: ''
+    type: string
+  max_invalidations:
+    description: 'Maximum number of invalidations to report. Defaults to `0` (no limit)'
+    required: false
+    default: '0'
+    type: number
 
 outputs:
   total: 
@@ -22,12 +32,16 @@ runs:
       id: info
       run: |
           REPONAME="${{ github.event.repository.name }}"
-          PACKAGENAME=${REPONAME%.jl}
+          if [[ '${{ inputs.package_name }}' == '' ]]; then
+            PACKAGENAME=${REPONAME%.jl}
+          else
+            PACKAGENAME="${{ inputs.package_name }}"
+          fi
           echo "packagename=$PACKAGENAME" >> $GITHUB_OUTPUT
           if [[ '${{ inputs.test_script }}' == '' ]]; then
             TESTSCRIPT="import ${PACKAGENAME}"
           else
-            TESTSCRIPT=${{ inputs.test_script }}
+            TESTSCRIPT="${{ inputs.test_script }}"
           fi
           echo "testscript=$TESTSCRIPT" >> $GITHUB_OUTPUT
       shell: bash
@@ -36,12 +50,12 @@ runs:
       run: |
         import Pkg;
         pkgs = [
-            Pkg.PackageSpec(name = "SnoopCompile", version = "2"),
-            Pkg.PackageSpec(name = "SnoopCompileCore"),
-            Pkg.PackageSpec(name = "PrettyTables"),
+            Pkg.PackageSpec(name = "SnoopCompile", version = "2", uuid = "aa65fe97-06da-5843-b5b1-d5d13cad87d2"),
+            Pkg.PackageSpec(name = "SnoopCompileCore", uuid = "e2b509da-e806-4183-be48-004708413034"),
+            Pkg.PackageSpec(name = "PrettyTables", uuid = "08abe8d2-0d0c-5749-adfa-8a2ac140af0d"),
         ]
         Pkg.add(pkgs)
-      shell: julia --project
+      shell: julia --project {0}
     - name: Load package on branch
       id: invs
       run: |
@@ -60,7 +74,7 @@ runs:
         SnoopCompile.report_invalidations(;
              invalidations,
              process_filename = x -> last(split(x, ".julia/packages/")),
-             n_rows = 0,  # no-limit (show all invalidations)
+             n_rows = ${{ inputs.max_invalidations }},
         )
 
         # Set outputs