🔧 Modernize CI/CD workflow with optimized settings

Modernize CI/CD workflow with optimized settings

Gave our CI/CD pipeline a much-needed refresh with these improvements:

- Upgrade actions/checkout (v2 → v4) and setup-node (v2 → v4)
- Switch to Node 20 LTS for better stability
- Replace manual caching with setup-node's built-in npm cache
- Add environment variables for cleaner configuration
- Set artifact retention period to 7 days
- Simplify release process with softprops/action-gh-release
- Add auto-generated release notes
- Make analyze job run in parallel with build
- Add explicit permissions config for security

These changes make our pipeline faster, more maintainable, and
future-proof! 🚀

Author: hyperb1iss

.github/workflows/ci-cd.yml

@@ -10,27 +10,22 @@ on:
     branches:
       - main
 
+env:
+  NODE_VERSION: '20' # LTS version for better stability
+  ARTIFACT_NAME: hyper-light-card.js
+  ARTIFACT_PATH: ./target/hyper-light-card.js
+
 jobs:
   build_and_test:
     name: Build + test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: '18'
-      - name: Cache node modules
-        uses: actions/cache@v2
-        env:
-          cache-name: cache-node-modules
+        uses: actions/setup-node@v4
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm' # This enables the built-in caching mechanism
       - name: Install dependencies
         run: npm ci
       - name: Run linter
@@ -42,18 +37,21 @@ jobs:
       - name: Upload build artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: hyper-light-card.js
-          path: ./target/hyper-light-card.js
+          name: ${{ env.ARTIFACT_NAME }}
+          path: ${{ env.ARTIFACT_PATH }}
+          retention-days: 7 # Keep artifacts for 7 days
+
   analyze:
     name: Analyze project
-    needs: build_and_test
     runs-on: ubuntu-latest
+    # Remove dependency on build_and_test since it doesn't need its artifacts
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Use Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
       - name: Install dependencies
         run: npm ci
       - name: Run ESLint
@@ -70,28 +68,19 @@ jobs:
   release:
     if: startsWith(github.ref, 'refs/tags/')
     needs: build_and_test
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
       - name: Download build artifact
         uses: actions/download-artifact@v4
         with:
-          name: hyper-light-card.js
-      - name: Create release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          name: ${{ env.ARTIFACT_NAME }}
+      - name: Create release and upload asset
+        uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
+          files: ${{ env.ARTIFACT_NAME }}
+          name: Release ${{ github.ref_name }}
           draft: false
           prerelease: false
-      - name: Upload release asset
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: hyper-light-card.js
-          asset_name: hyper-light-card.js
-          asset_content_type: application/javascript
+          generate_release_notes: true