Merge pull request #32 from particle-iot/chore/sc-125799

chore: [sc-125799] Update compile-action to run on Node 20

Author: laupow

.github/workflows/check-dist.yml

@@ -21,12 +21,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set Node.js 18.x
-        uses: actions/setup-node@v3.5.1
+      - name: Set Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
 
       - name: Install dependencies
         run: npm ci
@@ -45,7 +45,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/publish.yml

@@ -8,12 +8,12 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.release.tag_name }}
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - run: npm ci
       - run: npm run build
       - uses: JasonEtco/build-and-tag-action@v2

.github/workflows/test.yml

@@ -5,11 +5,11 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - run: |
           npm install
       - run: |
@@ -20,7 +20,7 @@ jobs:
         os: [ ubuntu-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./
         name: 'Cloud compile'
         with:
@@ -33,7 +33,7 @@ jobs:
         os: [ ubuntu-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: 'Verify product version is 100'
@@ -57,7 +57,7 @@ jobs:
         os: [ ubuntu-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./
         name: 'Local compile'
         with:
@@ -69,7 +69,7 @@ jobs:
         platform: [ 'core', 'p1', 'photon', 'electron', 'argon', 'boron' ]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./
         name: 'Local compile with ino source'
         with:

.nvmrc

@@ -1 +1 @@
-18.14
+20

AUTO_VERSION.md

@@ -60,7 +60,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Compile application
         id: compile
@@ -69,7 +69,7 @@ jobs:
           particle-platform-name: 'boron'
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: |
             ${{ steps.compile.outputs.firmware-path }}
@@ -107,7 +107,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -119,7 +119,7 @@ jobs:
           auto-version: true
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: |
             ${{ steps.compile.outputs.firmware-path }}

README.md

@@ -11,7 +11,7 @@ Other Actions for firmware development: Compile | [Flash Device](https://github.
 - uses: particle-iot/compile-action@v1
   with:
     # The platform name to target the compilation
-    # Allowed values: core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom
+    # Allowed values: core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom, electron2
     # Required: true
     particle-platform-name: ''
 
@@ -70,7 +70,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Compile application
         id: compile
@@ -79,7 +79,7 @@ jobs:
           particle-platform-name: 'boron'
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: firmware
           path: |
@@ -122,29 +122,7 @@ There is no scope for cloud compilation specifically, but your access token shou
 If you plan to [flash firmware](https://github.com/particle-iot/flash-device-action) to test devices, it will need the `devices:update` scope.
 If you plan to [upload product firmware binaries](https://github.com/particle-iot/firmware-upload-action) to the cloud, it will need the `firmware:create` scope.
 
-The best way to create an API user with the [API User tool](https://docs.particle.io/getting-started/cloud/cloud-api/#api-users).
-
-Here's an example of how to manually create an API User for just the `compile-action`:
-
-```bash
-# Create a new Particle access token with the `binary:compile` scope
-$ export TOKEN=<your Particle access token>
-$ export ORG_SLUG=<your Particle organization slug, visible in urls>
-$ curl "https://api.particle.io/v1/orgs/$ORG_SLUG/team?access_token=$TOKEN" -H "Content-Type: application/json" -d '{ "friendly_name": "GitHub Actions Compiling", "scopes": [ "binary:compile" ] }'
-{
-  "ok": true,
-  "created": {
-    "username": "[email protected]",
-    "is_programmatic": true,
-    "tokens": [
-      {
-        "token": "9383649a07fb505c6b4ae9d5exampleexample"
-      }
-    ]
-  }
-}
-```
-
+To create an API user, go to the Team page in your organization and click "Add API User".
 
 ## Known Issues
 

action.yml

@@ -37,5 +37,5 @@ outputs:
   firmware-version-updated:
     description: 'Boolean value indicating whether the product firmware version was updated. Can only be true with auto-version enabled.'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'