Merge branch 'main' into np-gm-1107

Author: nhivpham

.circleci/config.yml

@@ -67,15 +67,15 @@ references:
         - packages
 
   restore_node_modules: &restore_node_modules
-    attach_workspace:
+    attach_workspace: #The attach_workspace copies and re-creates the entire workspace content when it runs.
       at: ~/repo
 
   build_all_packages: &build_all_packages
     run:
       name: Build All Packages
       command: yarn build
 
-  set_git_user: &set_git_user
+  set_git_user: &set_git_user # move to yarn action maybe
     run:
       name: Set git user
       command: |
@@ -111,35 +111,13 @@ jobs:
   checkout_code:
     <<: *default_env
     steps:
-      - checkout
+      - checkout # circle keyword
       - *set_npm_token
       - *restore_yarn_cache
       - run: yarn --production=false --frozen-lockfile
       - *save_yarn_cache
       - *save_node_modules
 
-  tests:
-    <<: *default_env
-    resource_class: large
-    steps:
-      - checkout
-      - *restore_node_modules
-      - *restore_nx_cache
-      - *build_all_packages
-      - run:
-          name: Run test suite
-          command: |
-            yarn test --parallel=4 --ci --coverage -- --runInBand
-          environment:
-            JEST_JUNIT_OUTPUT_DIR: /tmp/test-results/junit
-            JEST_JUNIT_ADD_FILE_ATTRIBUTE: 'true'
-      - *save_nx_cache
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
-
   publish:
     <<: *default_env
     resource_class: large
@@ -176,92 +154,6 @@ jobs:
       - *save_nx_cache
       - *save_webpack_cache
 
-  deploy_alpha:
-    <<: *default_env
-    resource_class: large
-    steps:
-      - *skip_if_not_pr
-      - *skip_on_automated_commit
-      - *set_git_user
-      - checkout
-      - *restore_node_modules
-      - *restore_nx_cache
-      - *restore_webpack_cache
-      - *build_all_packages
-      - run:
-          name: build storybook
-          command: yarn nx run styleguide:build-storybook
-      - *save_nx_cache
-      - *save_webpack_cache
-      - run:
-          name: deploy
-          command: |
-            DEPLOY_MESSAGE="User: ${CIRCLE_USERNAME} Project: ${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME} Pull Request: ${CIRCLE_PULL_REQUEST}"
-            npx [email protected] deploy --message "${DEPLOY_MESSAGE}" --dir dist/storybook/styleguide --json --filter @codecademy/styleguide > .deploy-output
-      - setup_remote_docker
-      - run: docker pull cloudposse/github-commenter:0.5.0-58
-      - run:
-          name: comment
-          command: |
-            export DEPLOY_OUTPUT="$(cat .deploy-output)"
-            echo $DEPLOY_OUTPUT
-            DEPLOY_URL=$(echo "console.log(JSON.parse(process.env.DEPLOY_OUTPUT).deploy_url)" | node -)
-            LOGS_URL=$(echo "console.log(JSON.parse(process.env.DEPLOY_OUTPUT).logs)" | node -)
-            COMMENT_MSG="<p><a href="${DEPLOY_URL}">${DEPLOY_URL}</a></p><p><a href="${LOGS_URL}">Deploy Logs</a></p>"
-            if [ -z "$DEPLOY_OUTPUT" ]
-            then
-              echo "No deploy output found, will not add PR comment"
-            else
-              docker run --rm \
-                      -e GITHUB_TOKEN \
-                      -e GITHUB_OWNER="${CIRCLE_PROJECT_USERNAME}" \
-                      -e GITHUB_REPO="${CIRCLE_PROJECT_REPONAME}" \
-                      -e GITHUB_COMMENT_TYPE=pr \
-                      -e GITHUB_PR_ISSUE_NUMBER="${CIRCLE_PR_NUMBER:-${CIRCLE_PULL_REQUEST##*/}}" \
-                      -e GITHUB_COMMENT_TEMPLATE='<p>🚀 Styleguide deploy preview ready!</p>{{.}}<!--ALPHA_DEPLOY_COMMENT-->' \
-                      -e GITHUB_DELETE_COMMENT_REGEX="ALPHA_DEPLOY_COMMENT" \
-                      -e GITHUB_COMMENT="${COMMENT_MSG}" \
-                      cloudposse/github-commenter:0.5.0-58
-            fi
-
-  publish_alpha:
-    <<: *default_env
-    resource_class: large
-    steps:
-      - *skip_if_not_pr
-      - *skip_on_automated_commit
-      - *set_git_user
-      - checkout
-      - *restore_node_modules
-      - *set_npm_token
-      - *restore_nx_cache
-      - *build_all_packages
-      - *save_nx_cache
-      - run:
-          name: lerna publish (alpha)
-          command: yarn lerna publish --exact --yes --include-merged-tags --no-push --no-git-reset --conventional-commits --conventional-prerelease --preid=alpha.${CIRCLE_SHA1:0:6} --dist-tag=alpha.${CIRCLE_SHA1:0:6}
-      - setup_remote_docker
-      - run: docker pull cloudposse/github-commenter:0.5.0-58
-      - run:
-          name: Comment
-          command: |
-            ALPHA_PACKAGES="$(yarn lerna ll --parseable | grep alpha || true)"
-            if [ -z "$ALPHA_PACKAGES" ]
-            then
-              echo "No alpha published packages found, will not add PR comment"
-            else
-              docker run --rm \
-                      -e GITHUB_TOKEN \
-                      -e GITHUB_OWNER="${CIRCLE_PROJECT_USERNAME}" \
-                      -e GITHUB_REPO="${CIRCLE_PROJECT_REPONAME}" \
-                      -e GITHUB_COMMENT_TYPE=pr \
-                      -e GITHUB_PR_ISSUE_NUMBER="${CIRCLE_PR_NUMBER:-${CIRCLE_PULL_REQUEST##*/}}" \
-                      -e GITHUB_COMMENT_TEMPLATE='<h3>📬Published Alpha Packages:</h3><pre>{{$x := splitList "\n" .}}{{range $x}}{{$y := split ":" .}}{{printf "%s@%v<br/>" $y._1 $y._2}}{{end}}</pre><!--LERNA_VERSION_COMMENT-->' \
-                      -e GITHUB_DELETE_COMMENT_REGEX="LERNA_VERSION_COMMENT" \
-                      -e GITHUB_COMMENT="${ALPHA_PACKAGES}" \
-                      cloudposse/github-commenter:0.5.0-58
-            fi
-
 workflows:
   version: 2
   build-test:
@@ -272,23 +164,12 @@ workflows:
       - checkout_code:
           requires:
             - queue/block_workflow
-      - tests:
-          requires:
-            - checkout_code
       - publish:
           requires:
             - checkout_code
           filters:
             branches:
               only: main
-      - publish_alpha:
-          filters:
-            branches:
-              ignore:
-                - main
-                - gh-pages
-          requires:
-            - checkout_code
 
   deploy:
     jobs:
@@ -304,11 +185,3 @@ workflows:
           filters:
             branches:
               only: main
-      - deploy_alpha:
-          filters:
-            branches:
-              ignore:
-                - main
-                - gh-pages
-          requires:
-            - checkout_code

.github/actions/set-git-user/action.yml

@@ -0,0 +1,12 @@
+name: 'Set Git User'
+description: 'Set git user configuration for automated commits'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set git user
+      shell: bash
+      run: |
+        git config --global user.email "[email protected]"
+        git config --global user.name "codecademydev"
+        git config --global push.default current

.github/actions/set-npm-token/action.yml

@@ -0,0 +1,15 @@
+name: 'Set NPM Token'
+description: 'Set NPM authentication token in .npmrc file'
+
+inputs:
+  token-secret:
+    description: 'Name of the GitHub secret containing the NPM token'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set npm token
+      shell: bash
+      run: |
+        echo "//registry.npmjs.org/:_authToken=${{ inputs.token-secret }}" > .npmrc

.github/actions/skip-automated-commits/action.yml

@@ -0,0 +1,21 @@
+name: 'Skip Automated Commits'
+description: 'Skip workflow execution if triggered by automated commit messages'
+
+inputs:
+  ignore-commit-message:
+    description: 'Commit message pattern to ignore (e.g., chore(release): publish)'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Skip build from automated commit
+      id: check-commit
+      shell: bash
+      run: |
+        COMMIT_MESSAGE=$(git log --format=oneline -n 1 HEAD)
+        echo "Build started due to commit with message $COMMIT_MESSAGE, blocking builds started by ${{ inputs.ignore-commit-message }}"
+        if [[ $COMMIT_MESSAGE == *"${{ inputs.ignore-commit-message }}"* ]]; then
+          echo "Skipping build due to automated commit"
+          exit 0
+        fi

.github/actions/sticky-comment/action.yml

@@ -0,0 +1,28 @@
+name: 'Sticky Pull Request Comment'
+description: 'Post a sticky comment to a pull request with customizable content'
+
+inputs:
+  github-token:
+    description: 'GitHub token for authentication'
+    required: true
+  header:
+    description: 'Header text for the comment'
+    required: true
+  message:
+    description: 'Message content for the comment'
+    required: true
+  recreate:
+    description: 'Whether to recreate the comment on each run'
+    required: false
+    default: 'true'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Comment with sticky pull request comment
+      uses: marocchino/sticky-pull-request-comment@67d0dec7b07ed060a405f9b2a64b8ab319fdd7db
+      with:
+        GITHUB_TOKEN: ${{ inputs.github-token }}
+        header: ${{ inputs.header }}
+        recreate: ${{ inputs.recreate }}
+        message: ${{ inputs.message }}

.github/actions/validate-pr-context/action.yml

@@ -0,0 +1,13 @@
+name: 'Validate Pull Request Context'
+description: 'Ensure the workflow is running in a pull request context'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Ensure workflow is associated with a pull request
+      shell: bash
+      run: |
+        if [[ -z "${{ github.event.pull_request.number }}" ]]; then
+          echo "This workflow is not associated with a pull request; exiting"
+          exit 1
+        fi

.github/actions/yarn/action.yml

@@ -0,0 +1,14 @@
+name: 'Setup Node & yarn'
+description: 'Setup a NodeJS environment, install deps, & builds packages'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup Node.js
+      uses: actions/setup-node@3235b876344d2a9aa001b8d1453c930bba69e610
+      with:
+        node-version-file: .nvmrc
+
+    - name: Install dependencies
+      shell: bash
+      run: yarn --production=false --frozen-lockfile

.github/workflows/deploy-alpha.yml

@@ -0,0 +1,97 @@
+name: Deploy Storybook Preview
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+env:
+  NODE_VERSION: '22.13.1'
+  NODE_OPTIONS: '--max_old_space_size=8196'
+  NX_CLOUD: false
+  IGNORE_COMMIT_MESSAGE: 'chore(release): publish'
+
+permissions:
+  id-token: write
+  contents: read
+  pull-requests: write
+  issues: write
+
+jobs:
+  deploy-alpha:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup and Build
+        id: setup
+        uses: ./.github/actions/yarn
+
+      - name: Add NPM auth token file
+        uses: ./.github/actions/set-npm-token
+        with:
+          token-secret: ${{ secrets.NPM_TOKEN }}
+
+      - name: Ensure workflow is associated with a pull request
+        uses: ./.github/actions/validate-pr-context
+
+      - name: Skip build from automated commit
+        uses: ./.github/actions/skip-automated-commits
+        with:
+          ignore-commit-message: ${{ env.IGNORE_COMMIT_MESSAGE }}
+
+      - name: Set git user
+        uses: ./.github/actions/set-git-user
+
+      - name: Build All Packages
+        run: yarn build
+
+      - name: Build Storybook
+        run: yarn nx run styleguide:build-storybook
+
+      - name: Configure Netlify CLI
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+        run: |
+          cd packages/styleguide
+          npx [email protected] link --id ${{ secrets.NETLIFY_SITE_ID }}
+
+      - name: Deploy to Netlify
+        id: deploy
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+        run: |
+          DEPLOY_MESSAGE="User: ${{ github.actor }} Project: ${{ github.repository }} Pull Request: ${{ github.event.pull_request.html_url }}"
+          if npx [email protected] deploy --message "${DEPLOY_MESSAGE}" --dir dist/storybook/styleguide --filter @codecademy/styleguide --json > .deploy-output 2>&1; then
+            DEPLOY_OUTPUT=$(cat .deploy-output)
+            echo "deploy-output<<EOF" >> $GITHUB_OUTPUT
+            echo "$DEPLOY_OUTPUT" >> $GITHUB_OUTPUT
+            echo "EOF" >> $GITHUB_OUTPUT
+          else
+            echo "Deploy failed. Output:"
+            cat .deploy-output
+            exit 1
+          fi
+
+      - name: Extract deployment URLs
+        id: extract-urls
+        if: steps.deploy.outputs.deploy-output
+        run: |
+          DEPLOY_OUTPUT="${{ steps.deploy.outputs.deploy-output }}"
+          DEPLOY_URL=$(echo "$DEPLOY_OUTPUT" | grep -o 'deploy_url: [^,]*' | sed 's/deploy_url: //')
+          LOGS_URL=$(echo "$DEPLOY_OUTPUT" | grep -o 'logs: [^,]*' | sed 's/logs: //')
+          echo "deploy-url=$DEPLOY_URL" >> $GITHUB_OUTPUT
+          echo "logs-url=$LOGS_URL" >> $GITHUB_OUTPUT
+
+      - name: Comment with deployment preview
+        uses: ./.github/actions/sticky-comment
+        if: steps.extract-urls.outputs.deploy-url
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          header: Styleguide Deploy Preview
+          message: |
+            🚀 Styleguide deploy preview ready!
+
+            **Preview URL:** [${{ steps.extract-urls.outputs.deploy-url }}](${{ steps.extract-urls.outputs.deploy-url }})
+            **Deploy Logs:** [${{ steps.extract-urls.outputs.logs-url }}](${{ steps.extract-urls.outputs.logs-url }})