github/workflow cleanup (#7)

QuantumSavory · Feb 6, 2024 · fc7511f · fc7511f
1 parent 1375eee
commit fc7511f
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 30 deletions.
diff --git a/.github/workflows/benchmark-comment.yml b/.github/workflows/benchmark-comment.yml
@@ -42,7 +42,7 @@ jobs:
 
       # check if the previous comment exists
       - name: find comment
-        uses: peter-evans/find-comment@v2
+        uses: peter-evans/find-comment@v3
         id: fc
         with:
           issue-number: ${{ steps.output-pull-request-number.outputs.body }}
@@ -52,13 +52,13 @@ jobs:
       # create/update comment
       - name: create comment
         if: ${{ steps.fc.outputs.comment-id == 0 }}
-        uses: peter-evans/create-or-update-comment@v3
+        uses: peter-evans/create-or-update-comment@v4
         with:
           issue-number: ${{ steps.output-pull-request-number.outputs.body }}
           body: ${{ steps.output-result-markdown.outputs.body }}
       - name: update comment
         if: ${{ steps.fc.outputs.comment-id != 0 }}
-        uses: peter-evans/create-or-update-comment@v3
+        uses: peter-evans/create-or-update-comment@v4
         with:
           comment-id: ${{ steps.fc.outputs.comment-id }}
           body: ${{ steps.output-result-markdown.outputs.body }}
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -2,6 +2,9 @@ name: Performance tracking
 on:
   pull_request:
 
+env:
+  PYTHON: ~
+
 jobs:
   performance-tracking:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/ci-julia-nightly.yml b/.github/workflows/ci-julia-nightly.yml
@@ -4,6 +4,8 @@ on:
     branches: [master, main]
     tags: ["*"]
   pull_request:
+env:
+  PYTHON: ~
 jobs:
   test:
     name: Julia ${{ matrix.version }} - t=${{ matrix.threads }} - jet=${{ matrix.jet }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -28,22 +30,14 @@ jobs:
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v4
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
         env:
           JULIA_NUM_THREADS: ${{ matrix.threads }}
           JET_TEST: ${{ matrix.jet }}
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
-          file: lcov.info
+          file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,6 +4,8 @@ on:
     branches: [master, main]
     tags: ["*"]
   pull_request:
+env:
+  PYTHON: ~
 jobs:
   test:
     name: Julia ${{ matrix.version }} - t=${{ matrix.threads }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -12,13 +14,12 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1'
           - '1.9'
+          - '1'
         os:
           - ubuntu-latest
         threads:
           - '1'
-          - '5'
         arch:
           - x64
     steps:
@@ -27,24 +28,16 @@ jobs:
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v4
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
         env:
           JULIA_NUM_THREADS: ${{ matrix.threads }}
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
           file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
   docs:
     name: Documentation
     runs-on: ubuntu-latest
@@ -53,6 +46,7 @@ jobs:
       - uses: julia-actions/setup-julia@v1
         with:
           version: '1'
+      - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-docdeploy@v1
         env:

diff --git a/.github/workflows/downgrade.yml b/.github/workflows/downgrade.yml
@@ -8,6 +8,8 @@ on:
     branches: [master, main]
     paths-ignore:
       - 'docs/**'
+env:
+  PYTHON: ~
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -21,6 +23,7 @@ jobs:
           version: ${{ matrix.version }}
       - uses: cjdoris/julia-downgrade-compat-action@v1
         with:
-          skip: Pkg,TOML,InteractiveUtils,Random,LinearAlgebra
+          skip: Pkg,TOML,InteractiveUtils,Random,LinearAlgebra,Dates
+      - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
diff --git a/.github/workflows/invalidations.yml b/.github/workflows/invalidations.yml
@@ -20,6 +20,7 @@ jobs:
       with:
         version: '1'
     - uses: actions/checkout@v4
+    - uses: julia-actions/cache@v1
     - uses: julia-actions/julia-buildpkg@v1
     - uses: julia-actions/julia-invalidations@v1
       id: invs_pr

diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml
@@ -0,0 +1,15 @@
+name: Spell Check
+
+on: [pull_request]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+      - name: Check spelling
+        uses: crate-ci/typos@master
+        with:
+            config: .typos.toml
diff --git a/.typos.toml b/.typos.toml
@@ -0,0 +1,7 @@
+[default.extend-words]
+ket = "ket"
+
+[type.ipynb]
+# It detects false possitives in the base64 encoded images inside notebooks
+extend-glob = ["*.ipynb"]
+check-file = false
diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ julia> bpd = ldpc.bp_decoder(
            error_rate=0.1, # the error rate on each bit
            max_iter=n, # the maximum iteration depth for BP
            bp_method="product_sum", # BP method. The other option is `minimum_sum'
-           channel_probs=[nothing] # channel probability probabilities. Will overide error rate.
+           channel_probs=[nothing] # channel probability probabilities. Will override error rate.
        )
 PyObject <ldpc.bp_decoder.bp_decoder object at 0x7fea8283ab80>