feat(ipa): IPA Package config, docs and release workflow (#855)

Author: sphterry

.github/scripts/ipa_version_check.sh

@@ -0,0 +1,16 @@
+#!/bin/bash  
+set -eou pipefail
+  
+current_version=$(jq -r '.version' tools/spectral/ipa/package.json)  
+
+previous_version=$(git show origin/"${BASE_BRANCH}":tools/spectral/ipa/package.json | jq -r '.version')  
+  
+if [[ -z "${previous_version}" || "${previous_version}" == "null" ]]; then  
+  previous_version="none"  
+fi  
+  
+if [[ "${previous_version}" == "${current_version}" ]]; then  
+  echo "false"  
+else  
+  echo "true"  
+fi  

.github/workflows/ipa-changelog.yml

@@ -14,39 +14,35 @@ jobs:
     - name: Checkout Repository  
       uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
       with:
+          fetch-depth: 0 
           sparse-checkout: |
-            tools/spectral/ipa  
+            tools/spectral/ipa
+            .github/scripts
         
     - name: Fetch Versions
-      working-directory: tools/spectral/ipa
       id: version_check
+      env:   
+        BASE_BRANCH: ${{ github.event.pull_request.base.ref }}
       run: |
-        current_version=$(jq '.version' package.json)
-        echo "Current version: $current_version"
-
-        previous_version=$(git show origin/${{ github.event.pull_request.base.ref }}:tools/spectral/ipa/package.json | jq -r '.version') 
-  
-        if [[ -z "$previous_version" || "$previous_version" == "null" ]]; then   
-          previous_version="none"  
-        fi 
-        echo "Previous version: $previous_version"
-
+        version_changed=$(./.github/scripts/ipa_version_check.sh)  
+        echo "Version changed? ${version_changed}"  
+        echo "version_changed=${version_changed}" >> "${GITHUB_OUTPUT}"
     - name: Check Changelog
       working-directory: tools/spectral/ipa
       env: 
-        VERSION_BUMP: ${{ steps.version_check.outputs.current_version != steps.version_check.outputs.previous_version && 'true' || 'false' }}
+        VERSION_BUMP: ${{ steps.version_check.outputs.version_changed }}
       run: | 
         npm run gen-ipa-changelog
 
         # Check for uncommitted changes specific to CHANGELOG.md  
         uncommitted_changes=$(git status --porcelain | grep "CHANGELOG.md" || echo "")  
   
-        if [[ "$VERSION_BUMP" == "false" && -n "$uncommitted_changes" ]]; then  
+        if [[ "${VERSION_BUMP}" == "false" && -n "${uncommitted_changes}" ]]; then  
           echo "Error: Changelog should only be updated alongside a version bump. Please restore the changelog."  
           exit 1  
         fi  
 
-        if [[ "$VERSION_BUMP" == "true" && -z "$uncommitted_changes" ]]; then  
+        if [[ "${VERSION_BUMP}" == "true" && -z "${uncommitted_changes}" ]]; then  
           echo "Error: Changelog must be updated alongside a version bump. Please run 'npm run gen-ipa-changelog' from the ipa directory and commit the changes."  
           exit 1  
         fi 

.github/workflows/ipa-release.yml

@@ -0,0 +1,51 @@
+name: Release IPA Package
+
+on:  
+  workflow_dispatch:
+  push: 
+    branches:
+      - main
+    paths:
+      - 'tools/spectral/ipa/package.json'
+
+jobs:
+  check-version:
+    runs-on: ubuntu-latest  
+    outputs:  
+      version_changed: ${{ steps.version_check.outputs.version_changed }}  
+      
+    steps:
+    - name: Checkout Repository  
+      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+      with:
+          fetch-depth: 0
+          sparse-checkout: |
+            tools/spectral/ipa  
+            .github/scripts
+    - name: Fetch Versions
+      id: version_check
+      run: |
+        version_changed=$(./.github/scripts/ipa_version_check.sh)  
+        echo "Version changed? ${version_changed}"  
+        echo "version_changed=${version_changed}" >> "${GITHUB_ENV}"
+  
+  publish:
+    needs: check-version
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    if: ${{ needs.check-version.outputs.version_changed == 'true' }}
+
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+        working-directory: tools/spectral/ipa
+      - run: npm publish --access public
+        working-directory: tools/spectral/ipa
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.IPA_VALIDATION_TOKEN }}

CONTRIBUTING.md

@@ -66,3 +66,5 @@ When working in the `tools/cli` directory:
 - `make e2e-test` - Run end-to-end tests
 - `make build` - Build the CLI binary
 - `make gen-docs` - Generate CLI documentation
+
+**Note: Please ensure the usage of [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) in PR titles**