feat(nx-migrate-action): add github action to perform nx migrations

closed COD-128

Author: hakalb

.actrc

@@ -0,0 +1,2 @@
+-P ubuntu-latest=catthehacker/ubuntu:act-latest
+--container-architecture linux/amd64

.env.local

@@ -1 +1,2 @@
-NX_NO_CLOUD=true
+ACTIONS_STEP_DEBUG=true
+NX_NO_CLOUD=true

.github/workflows/README.md

@@ -0,0 +1,100 @@
+# Running GitHub Actions Workflows Locally
+
+## Getting Started
+
+### Install `act`
+
+#### macOS
+
+```sh
+brew install act
+```
+
+#### Linux
+
+```sh
+curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash
+```
+
+#### Windows (with Chocolatey)
+
+```powershell
+choco install act-cli
+```
+
+> Remove or change `--container-architecture` in `.actrc` file.
+
+### Secrets & Variables
+
+Copy `.secrets.example` to `.secrets`.
+
+Create your own PAT for test and replace the value for `GITHUB_TOKEN`.
+
+- [Classic tokens](https://github.com/settings/tokens)
+- [Fine-grained tokens](https://github.com/settings/tokens?type=beta)
+
+`.vars` contains the variables used by the workflows.
+
+Add more or update values in these files when needed.
+
+## TLDR
+
+```sh
+# Validate `nx-migrate.yml`
+act schedule -n -j nx-migrate
+
+# Run `nx-migrate.yml` with local env file applied
+act schedule --env-file .env.local -j nx-migrate
+```
+
+## Basic Usage
+
+```sh
+# Run all workflows
+act
+
+# Run a specific workflow
+act -W .github/workflows/specific-workflow.yml
+
+# List all available actions
+act -l
+
+# Run a specific event
+act push
+```
+
+## Common Options
+
+```sh
+# Dry run
+act -n
+
+# Enable verbose logging
+act -v
+
+# Use workspace local env file instead of default `.env`
+act --env-file .env.local
+
+# Run workflow with specific inputs
+act workflow_dispatch -i input1=value1 -i input2=value2
+```
+
+## Debugging Tips
+
+### Use `-v` flag for verbose output
+
+```sh
+act -v
+```
+
+### Check container logs
+
+```sh
+docker logs $(docker ps -q --filter ancestor=catthehacker/ubuntu:act-latest)
+```
+
+### Interactive debugging
+
+```sh
+act -i
+```

.github/workflows/ci.yml

@@ -37,13 +37,13 @@ jobs:
           node-version: 'lts/*'
           cache: 'pnpm'
 
-      - run: pnpm nx-cloud start-ci-run --distribute-on="3 linux-small-js" --stop-agents-after="e2e-ci"
+      - run: pnpx nx-cloud start-ci-run --distribute-on="3 linux-small-js" --stop-agents-after="e2e-ci"
         if: ${{ vars.NX_NO_CLOUD != 'true' }}
 
       - run: pnpm install --frozen-lockfile
       - uses: nrwl/nx-set-shas@v4
 
-      - run: pnpm nx-cloud record -- nx format:check
+      - run: pnpx nx-cloud record -- nx format:check
         if: ${{ vars.NX_NO_CLOUD != 'true' }}
         shell: bash
 

.github/workflows/nx-migrate.yml

@@ -0,0 +1,42 @@
+name: Nx migrate
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Every day at 6am UTC
+    - cron: '0 6 * * *'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  nx-migrate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build action
+        run: pnpm nx build nx-migrate-action
+
+      - name: Run Nx migrate
+        uses: ./packages/nx-migrate-action
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          auto-merge: ${{ vars.NX_AUTO_MIGRATE }}
+          check-token: ${{ vars.NX_MIGRATE_CHECK_TOKEN }}
+          skip-e2e: ${{ vars.NX_MIGRATE_SKIP_E2E }}
+          dry-run: ${{ vars.NX_MIGRATE_DRY_RUN }}

.gitignore

@@ -30,6 +30,7 @@ yarn.lock
 !.vscode/extensions.json
 
 # misc
+/.pnpm-store
 /.sass-cache
 /.pnpm-store
 /connect.lock
@@ -50,3 +51,6 @@ Thumbs.db
 migrations.json
 
 **/vite.config.{js,ts,mjs,mts,cjs,cts}.timestamp*
+
+# Act
+.secrets

.nx/workflows/agents.yaml

@@ -0,0 +1 @@
+GITHUB_TOKEN=your_test_token_here

.secrets.example

@@ -0,0 +1,5 @@
+# .github/workflows/nx-migrate.yml
+NX_AUTO_MIGRATE=false
+NX_MIGRATE_CHECK_TOKEN=true
+NX_MIGRATE_SKIP_E2E=true
+NX_MIGRATE_DRY_RUN=false

.vars

@@ -0,0 +1,28 @@
+# path to a directory with all packages
+storage: ../tmp/local-registry/storage
+
+# a list of other known repositories we can talk to
+uplinks:
+  npmjs:
+    url: https://registry.npmjs.org/
+    maxage: 60m
+
+packages:
+  '**':
+    # give all users (including non-authenticated users) full access
+    # because it is a local registry
+    access: $all
+    publish: $all
+    unpublish: $all
+
+    # if package is not available locally, proxy requests to npm registry
+    proxy: npmjs
+
+# log settings
+log:
+  type: stdout
+  format: pretty
+  level: warn
+
+publish:
+  allow_offline: true # set offline to true to allow publish offline