ci: add publish package workflow

bang9 · bang9 · commit 3f506b1b82d6 · 2024-05-28T17:16:24.000+09:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -6,7 +6,7 @@ aliases:
     key: v{{ .Environment.CACHE_VERSION }}-yarn-packages-{{ arch }}-{{ checksum "yarn.lock" }}
   - &install_node_modules
     name: Install node_modules
-    command: yarn install --immutable
+    command: yarn install --frozen-lockfile
   - &save_node_modules_base
     key: v{{ .Environment.CACHE_VERSION }}-yarn-base-{{ arch }}-{{ checksum "yarn.lock" }}
     paths:
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,9 +19,9 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -31,14 +31,14 @@ jobs:
 
       - name: Check cached node_modules
         id: check_cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_NODE_MODULES_PATH }}
           key: ${{ steps.lockfile_hash.outputs.hash }}
 
       - name: Install dependencies
         if: steps.check_cache.outputs.cache-hit == ''
-        run: yarn install --immutable
+        run: yarn install --frozen-lockfile
     outputs:
       cache_node_modules_key: ${{ steps.lockfile_hash.outputs.hash }}
 
@@ -49,14 +49,14 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Check cached node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_NODE_MODULES_PATH }}
           key: ${{ needs.prepare.outputs.cache_node_modules_key }}
@@ -71,14 +71,14 @@ jobs:
       matrix:
         node-version: [16.x, 18.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Check cached node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_NODE_MODULES_PATH }}
           key: ${{ needs.prepare.outputs.cache_node_modules_key }}
@@ -93,14 +93,14 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Check cached node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_NODE_MODULES_PATH }}
           key: ${{ needs.prepare.outputs.cache_node_modules_key }}
@@ -109,7 +109,7 @@ jobs:
         run: yarn test --collect-coverage
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
@@ -121,14 +121,14 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Check cached node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_NODE_MODULES_PATH }}
           key: ${{ needs.prepare.outputs.cache_node_modules_key }}
diff --git a/.github/workflows/comment-bot.yml b/.github/workflows/comment-bot.yml
@@ -6,8 +6,8 @@ jobs:
   pr-comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: sendbird/release-automation-action@0.0.4
+      - uses: actions/checkout@v4
+      - uses: sendbird/release-automation-action@latest
         with:
           gh_token: ${{ secrets.GITHUB_TOKEN }}
           circleci_token: ${{ secrets.CIRCLECI_BOT_TOKEN }}
diff --git a/.github/workflows/publish-package.yml b/.github/workflows/publish-package.yml
@@ -0,0 +1,63 @@
+name: publish package to npm
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'version'
+        required: true
+        type: string
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+      - name: 'validation'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const permission = await github.repos.getCollaboratorPermissionLevel({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              username: context.actor
+            });
+            if (permission.data.permission !== 'admin' && permission.data.permission !== 'write') {
+              core.setFailed(`User ${context.actor} does not have write or admin permissions to this repository.`);
+            }
+            const currentBranch = context.ref.replace('refs/heads/', '');
+            if (currentBranch !== `release/${{ github.event.inputs.version }}`) {
+              core.setFailed(`Current branch ${currentBranch} does not match release/${{ github.event.inputs.version }}`);
+            }
+            const pullRequests = await github.pulls.list({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open',
+              sort: 'created',
+              direction: 'desc',
+            });
+            const pr = pullRequests.data.find(pr => pr.head.ref === currentBranch && pr.base.ref === 'main');
+            if (!pr) {
+              core.setFailed(`No open pull request found for ${currentBranch} to main`);
+            }
+            core.exportVariable('PR_NUMBER', pr.number);
+      - run: yarn install --frozen-lockfile
+      - name: 'set environments'
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.npm_token }}" >> .npmrc
+          git config --global user.email "sha.sdk_deployment@sendbird.com"
+          git config --global user.name "sendbird-sdk-deployment"
+      - name: 'publish to npm'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          lerna version ${{ github.event.inputs.version }} --yes
+          lerna publish from-git --yes
+      - name: 'approve a pull request'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr review ${{ env.PR_NUMBER }} --approve --body "approved by automation"
diff --git a/.github/workflows/publish-sample.yml b/.github/workflows/publish-sample.yml
@@ -1,4 +1,4 @@
-name: deployment trigger
+name: publish sample application
 
 on:
   workflow_dispatch:
@@ -64,7 +64,7 @@ jobs:
 #          key: ${{ steps.lockfile_hash.outputs.hash }}
 #      - name: Install dependencies
 #        if: steps.check_cache.outputs.cache-hit == ''
-#        run: yarn install --immutable
+#        run: yarn install --frozen-lockfile
 #      - name: Create env.ts
 #        run:
 #          echo "export const APP_ID = '${{ secrets.sendbird_app_id }}';" >> sample/src/env.ts
@@ -117,7 +117,7 @@ jobs:
 #      - name: Install dependencies
 #        if: steps.check_cache.outputs.cache-hit == ''
 #        run:
-#          yarn install --immutable
+#          yarn install --frozen-lockfile
 #      - name: Install pods
 #        run: cd sample/ios && pod install
 #      - name: Create env.ts
diff --git a/RELEASE_GUIDE.md b/RELEASE_GUIDE.md
@@ -0,0 +1,38 @@
+# Release Guide
+
+This guide describes how to create and deploy a new release of the project.
+
+## Step 1: Create a release branch
+
+Create a branch for the new release. The branch name should follow the `release/X.Y.Z` format, where `X.Y.Z` represents the release version.
+
+```bash
+git checkout -b release/X.Y.Z
+```
+
+## Step 2: Write CHANGELOG_DRAFT.md
+
+Record the changes for this release in the `CHANGELOG_DRAFT.md` file.
+
+## Step 3: Commit and push changes
+
+Commit the changes you've made and push the branch to the remote repository.
+
+```bash
+git add .
+git commit -m "chore: update changelog draft"
+git push origin release/X.Y.Z
+```
+
+## Step 4: Create a PR and ticket
+
+Create a Pull Request for the newly pushed branch. The PR should be requested to the `main` branch.
+And add a `/bot create ticket` comment to create a ticket in the project management tool.
+
+## Step 5: Run the publish-package workflow
+
+Execute the `publish-package` workflow in GitHub Actions. This workflow is defined in the `.github/workflows/publish-package.yml` file.
+
+1. workflow uses `lerna` to update the `changelog.md` file based on the commit history and creates a GitHub release.
+2. The workflow also publishes the package to NPM.
+3. If all the steps are completed successfully, the PR is approved by the bot.
