ci: add action to install algokit

.github/actions/use-algokit/action.yml

@@ -0,0 +1,37 @@
+name: "Use AlgoKit"
+
+description: "Checks if the dependencies have been cached with the hash of the package-lock.json file."
+
+inputs:
+  algokit_version:
+    description: "The version of AlgoKit to install"
+    required: false
+    default: "latest"
+
+runs:
+  using: "composite"
+  steps:
+    - name: "🔑 Set up cache key"
+      id: cache-key
+      run: echo "CACHE_KEY=algokit-${{ inputs.algokit_version }}-$(python --version | cut -d' ' -f2)" >> $GITHUB_ENV
+    - name: "💾 Cache dependencies"
+      id: algokit-cache
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ env.CACHE_KEY }}
+        restore-keys: |
+          ${{ runner.os }}-algokit-${{ inputs.algokit_version }}
+          ${{ runner.os }}-algokit-
+          ${{ runner.os }}-
+    - name: "🔧 Setup"
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.12'
+    - name: "📤 Upgrade pip"
+      run: python -m pip install --upgrade pip
+      shell: bash
+    - name: "📦 Install"
+      if: steps.algokit-cache.outputs.cache-hit != 'true'
+      run: pip install algokit==${{ inputs.algokit_version }}
+      shell: bash

.github/actions/use-dependencies/action.yml → .github/actions/use-npm-dependencies/action.yml

@@ -1,6 +1,6 @@
-name: "Use Dependencies"
+name: "Use npm Dependencies"
 
-description: "Checks if the dependencies have been cached with the hash of the package-lock.json file."
+description: "Checks if the npm dependencies have been cached with the hash of the package-lock.json file."
 
 runs:
   using: "composite"

.github/workflows/pull_request_checks.yml

@@ -15,7 +15,7 @@ jobs:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+        uses: ./.github/actions/use-npm-dependencies
 
   get_changed_files:
     name: "Get Changed Files"
@@ -51,7 +51,7 @@ jobs:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+        uses: ./.github/actions/use-npm-dependencies
       - name: "📥 Get PR Title"
         id: get_pr_title
         uses: actions/github-script@v7
@@ -80,7 +80,7 @@ jobs:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+        uses: ./.github/actions/use-npm-dependencies
       - name: "🔍 Type Check"
         run: npm run check:types --workspace=@kibisis/pinakion-js-client
 
@@ -93,7 +93,7 @@ jobs:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+        uses: ./.github/actions/use-npm-dependencies
       - name: "👕 Lint"
         run: npm run lint:contract
 
@@ -106,7 +106,7 @@ jobs:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+        uses: ./.github/actions/use-npm-dependencies
       - name: "👕 Lint"
         run: npm run lint:js-client
 
@@ -118,7 +118,9 @@ jobs:
     steps:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
-      - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+      - name: "🔧 Setup npm Dependencies"
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "🔧 Setup AlgoKit"
+        uses: ./.github/actions/use-algokit
       - name: "🧪 Test"
         run: npm run test:js-client

.github/workflows/release.yml

@@ -21,7 +21,9 @@ jobs:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "🔧 Setup AlgoKit"
+        uses: ./.github/actions/use-algokit
       - name: "🏗️ Build"
         run: npm run build:contract
       - name: "🔖 Release"
@@ -45,7 +47,9 @@ jobs:
       - name: "🛎 Checkout"
         uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: ./.github/actions/use-dependencies
+        uses: ./.github/actions/use-npm-dependencies
+      - name: "🔧 Setup AlgoKit"
+        uses: ./.github/actions/use-algokit
       - name: "📝 Create .npmrc"
         run: |
           echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_PUBLISH_PACKAGES_ACCESS_TOKEN }}" >> .npmrc

README.md

@@ -83,10 +83,10 @@ npm install
 
 ### 3.1. Packages
 
-| Name                                                            | Description                                                       |
-|-----------------------------------------------------------------|-------------------------------------------------------------------|
-| [`pinakion-contract`](./packages/pinakion-contract/README.md)   | The Kibisis Pinakion NFT contract written in TEALScript.          |
-| [`pinakion-js-client`](./packages/pinakion-js-client/README.md) | The JS client to interact with the Kibisis Pinakion NFT contract. |
+| Name                                                   | Description                                                       |
+|--------------------------------------------------------|-------------------------------------------------------------------|
+| [`contract`](./packages/pinakion-contract/README.md)   | The Kibisis Pinakion NFT contract written in TEALScript.          |
+| [`js-client`](./packages/pinakion-js-client/README.md) | The JS client to interact with the Kibisis Pinakion NFT contract. |
 
 <sup>[Back to top ^][table-of-contents]</sup>