name: Deploy CD run-name: ${{ github.actor }} is running Deploy CD on: push: branches: # White-list of deployable tags and branches. Note that all white-listed branches cannot include any `/` characters - next env: rid: ${{ github.run_id }}-${{ github.run_number }} token: ${{ secrets.NPM_TOKEN }} GIT_AUTHOR_NAME: ${{ github.actor }} GIT_AUTHOR_EMAIL: ${{ github.actor }}@users.noreply.github.com jobs: initialize: name: Initialize Project runs-on: ubuntu-latest steps: - name: Checkout Project uses: actions/checkout@v6 - name: Setup Node uses: actions/setup-node@v6 with: node-version-file: '.nvmrc' registry-url: 'https://registry.npmjs.org' cache: 'yarn' - id: restore-dependencies name: Restore Dependencies uses: actions/cache/restore@v5 with: path: '**/node_modules' key: node-modules-${{ hashFiles('./yarn.lock') }} - name: Install Dependencies run: yarn - name: Cache Dependencies uses: actions/cache/save@v5 if: steps.restore-dependencies.outputs.cache-hit != 'true' with: path: '**/node_modules' key: ${{ steps.restore-dependencies.outputs.cache-primary-key }} build: name: Build Packages needs: initialize runs-on: ubuntu-latest steps: - name: Checkout Project uses: actions/checkout@v6 - name: Setup Node uses: actions/setup-node@v6 with: node-version-file: '.nvmrc' registry-url: 'https://registry.npmjs.org' cache: 'yarn' - name: Uncache Dependencies uses: actions/cache@v5 with: path: '**/node_modules' key: node-modules-${{ hashFiles('./yarn.lock') }} - name: Synchronize Packages run: yarn - name: Build Tools run: yarn workspaces foreach --from '@webex/*-tools' --topological-dev --parallel --verbose run build:src - name: Build Webex Core run: yarn workspace @webex/webex-core run build:src - name: Build Other Packages run: yarn workspaces foreach --parallel --topological --verbose run build:src - name: Cache Distributables uses: actions/cache@v5 with: path: '**/dist' key: dist-${{ env.rid }} generate-package-matrix: name: Determine Changed Packages needs: build runs-on: ubuntu-latest outputs: node-changed: ${{ steps.generate-package-matrix-node-changed.outputs.node-changed }} # Used for execution. node-recursive: ${{ steps.generate-package-matrix-node-recursive.outputs.node-recursive }} # Used for execution. yarn-changed: ${{ steps.generate-package-matrix-yarn-changed.outputs.yarn-changed }} # Used for workspaces. yarn-recursive: ${{ steps.generate-package-matrix-yarn-recursive.outputs.yarn-recursive }} # Used for workspaces. steps: - name: Checkout Project uses: actions/checkout@v6 - name: Setup Node uses: actions/setup-node@v6 with: node-version-file: '.nvmrc' registry-url: 'https://registry.npmjs.org' cache: 'yarn' - name: Uncache Dependencies uses: actions/cache@v5 with: path: '**/node_modules' key: node-modules-${{ hashFiles('./yarn.lock') }} - name: Uncache Distributables uses: actions/cache@v5 with: path: '**/dist' key: dist-${{ env.rid }} - name: Synchronize Packages run: yarn - name: Update Main Branch run: git fetch origin ${GITHUB_REF##*/} --unshallow # Used for running node scripts against all changed packages since the last push to the target branch. - id: generate-package-matrix-node-changed name: Generate Package Matrix # webexconnect is a private package and is already omitted by `list` (--no-private is the default); # this sed is an explicit second guard so `@webex/webexconnect` can never leak into the deploy matrix # even if `private: true` is ever accidentally removed from its package.json. run: | echo "node-changed=$(yarn package-tools list --mode node --committed --since ${{ github.event.before }} | sed -E 's#@webex/webexconnect##g; s#,+#,#g; s#\{,#{#g; s#,\}#}#g; s# +# #g; s#^ ##; s# $##')" >> $GITHUB_OUTPUT # Used for running node scripts against all changed packages, and their dependents, since the last push to the target branch. - id: generate-package-matrix-node-recursive name: Generate Package Matrix run: | echo "node-recursive=$(yarn package-tools list --mode node --recursive --committed --since ${{ github.event.before }} | sed -E 's#@webex/webexconnect##g; s#,+#,#g; s#\{,#{#g; s#,\}#}#g; s# +# #g; s#^ ##; s# $##')" >> $GITHUB_OUTPUT # Used for running yarn tools against all changed packages since the last push to the target branch. - id: generate-package-matrix-yarn-changed name: Generate Package Matrix run: | echo "yarn-changed=$(yarn package-tools list --committed --since ${{ github.event.before }} | sed -E 's#@webex/webexconnect##g; s#,+#,#g; s#\{,#{#g; s#,\}#}#g; s# +# #g; s#^ ##; s# $##')" >> $GITHUB_OUTPUT # Used for running yarn tools against all changed packages, and their dependents, since the last push to the target branch. - id: generate-package-matrix-yarn-recursive name: Generate Package Matrix run: | echo "yarn-recursive=$(yarn package-tools list --recursive --committed --since ${{ github.event.before }} | sed -E 's#@webex/webexconnect##g; s#,+#,#g; s#\{,#{#g; s#,\}#}#g; s# +# #g; s#^ ##; s# $##')" >> $GITHUB_OUTPUT - name: Display Package Matrix run: | echo "changed packages for node - ${{ steps.generate-package-matrix-node-changed.outputs.node-changed}}" echo "changed packages and dependents for node - ${{ steps.generate-package-matrix-node-recursive.outputs.node-recursive }}" echo "changed packages for yarn - ${{ steps.generate-package-matrix-yarn-changed.outputs.yarn-changed}}" echo "changed packages and dependents for yarn - ${{ steps.generate-package-matrix-yarn-recursive.outputs.yarn-recursive }}" publish-npm: name: Publish - NPM needs: generate-package-matrix runs-on: ubuntu-latest outputs: package_versions: ${{ steps.increment.outputs.package_versions }} steps: - name: Checkout Project uses: actions/checkout@v6 - name: Setup Node uses: actions/setup-node@v6 with: node-version-file: '.nvmrc' registry-url: 'https://registry.npmjs.org' cache: 'yarn' - name: Uncache Dependencies uses: actions/cache@v5 with: path: '**/node_modules' key: node-modules-${{ hashFiles('./yarn.lock') }} - name: Uncache Distributables uses: actions/cache@v5 with: path: '**/dist' key: dist-${{ env.rid }} - name: Add NPM token to .yarnrc.yml file run: | echo "npmAuthToken: ${{ env.token }}" >> ~/.yarnrc.yml - name: Synchronize Packages run: | yarn yarn package-tools sync --tag ${GITHUB_REF##*/} - name: Display Notice run: | echo "packages to increment: ${{ needs.generate-package-matrix.outputs.node-recursive }}" echo "tag to increment: ${GITHUB_REF##*/}" - name: Increment Package Versions id: increment run: | OUTPUT=$(yarn package-tools increment --packages ${{ needs.generate-package-matrix.outputs.node-recursive }} --tag ${GITHUB_REF##*/}) echo "$OUTPUT" echo "package_versions<> $GITHUB_OUTPUT echo "$OUTPUT" >> $GITHUB_OUTPUT echo "EOF" >> $GITHUB_OUTPUT - name: Build all packages for publish run: yarn run build:publish - name: Build a webex UMD run: yarn run build:script - name: Deploy Packages run: yarn workspaces foreach --from '${{ needs.generate-package-matrix.outputs.yarn-recursive }}' --verbose run deploy:npm --access public --tag ${GITHUB_REF##*/} env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} publish-documentation: name: Publish - Documentation needs: [publish-npm,generate-package-matrix] runs-on: ubuntu-latest if: github.ref != 'refs/heads/wxcc' steps: - name: Documentation Deploy Steps run: echo "Documentation Deploy Steps" - name: Checkout Project uses: actions/checkout@v6 with: fetch-depth: 0 - name: Setup Node uses: actions/setup-node@v6 with: node-version-file: '.nvmrc' registry-url: 'https://registry.npmjs.org' cache: 'yarn' - name: Uncache Dependencies uses: actions/cache@v5 with: path: '**/node_modules' key: node-modules-${{ hashFiles('./yarn.lock') }} - name: Uncache Distributables uses: actions/cache@v5 with: path: '**/dist' key: dist-${{ env.rid }} - name: Synchronize Packages run: yarn - name: Build tools and set versions run: | yarn workspaces foreach --from '@webex/*-tools' --topological-dev --parallel --verbose run build:src yarn package-tools sync --tag ${GITHUB_REF##*/} - name: Build packages locally run: yarn build:local - name: Build Docs run: yarn run build:docs - name: Set Git Identity run: | git config user.email "${GIT_AUTHOR_EMAIL}" git config user.name "${GIT_AUTHOR_NAME}" - name: Get existing changelog from documentation Branch run: | git fetch origin documentation git checkout origin/documentation -- docs/changelog/logs - name: Update changelog run: yarn package-tools changelog --packages ${{ needs.generate-package-matrix.outputs.node-recursive }} --tag ${GITHUB_REF##*/} --commit ${{ github.event.before }} - name: Update Changelog and Publish Docs Folder run: | # Check if there's anything to commit before committing if [ -n "$(git status --porcelain)" ]; then git add docs/ # The web sample's bundle is generated rather than committed (see # .gitignore), so a plain `git add` skips it and the hosted page 404s. # Force only this path: the extension half stays unpublished because its # manifest is origin-baked for local testing and must not ship. git add -f docs/samples/web-extension-bridge/vendor git commit -m "chore(docs): update docs" git push origin HEAD:documentation --force fi publish-tag: name: Publish - Tags runs-on: ubuntu-latest needs: [generate-package-matrix, publish-npm] outputs: message: ${{ steps.versionextractor.outputs.message }} version: ${{ steps.versionextractor.outputs.version }} commit: ${{ steps.lastcommit.outputs.commit }} proceed: ${{ steps.skipcondition.outputs.proceed }} steps: - name: Checkout Project uses: actions/checkout@v6 - name: Setup Node uses: actions/setup-node@v6 with: node-version-file: '.nvmrc' registry-url: 'https://registry.npmjs.org' cache: 'yarn' - name: Uncache Dependencies uses: actions/cache@v5 with: path: '**/node_modules' key: node-modules-${{ hashFiles('./yarn.lock') }} - name: Uncache Distributables uses: actions/cache@v5 with: path: '**/dist' key: dist-${{ env.rid }} - name: Synchronize Packages run: yarn - name: Extract latest version from NPM and commit message id: versionextractor run: | yarn ws:tools echo "message=$(git log -1 --oneline --no-decorate)" >> $GITHUB_OUTPUT echo "version=v$(yarn package-tools sync --tag ${GITHUB_REF##*/} --packages webex | awk '{print $3}' | tr -d '%')" >> $GITHUB_OUTPUT - name: Conditions to skip tag publish id: skipcondition run: | echo "proceed=true" >> $GITHUB_OUTPUT if git rev-parse "${{ steps.versionextractor.outputs.version }}" >/dev/null 2>&1; then echo "Tag ${{ steps.versionextractor.outputs.version }} already exists. Exiting job." echo "proceed=false" >> $GITHUB_OUTPUT elif [ -z ${{ needs.generate-package-matrix.outputs.node-recursive }} ]; then echo "No packages published, therefore, publishing a tag is unnecessary. Exiting job." echo "proceed=false" >> $GITHUB_OUTPUT else echo "Creating the tag." fi - name: Get the last commit hash id: lastcommit run: | if [ ${{ steps.skipcondition.outputs.proceed }} = false ]; then echo "Skipping this step." else echo "commit=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT fi - name: Set Git Identity run: | if [ ${{ steps.skipcondition.outputs.proceed }} = false ]; then echo "Skipping this step." else git config user.email "${GIT_AUTHOR_EMAIL}" git config user.name "${GIT_AUTHOR_NAME}" fi - name: Create a tag for the last commit run: | if [ ${{ steps.skipcondition.outputs.proceed }} = false ]; then echo "Skipping this step." else git tag -a "${{ steps.versionextractor.outputs.version }}" ${{ steps.lastcommit.outputs.commit }} -m "${{ steps.versionextractor.outputs.message }}" fi - name: Publish the tag to GitHub run: | if [ ${{ steps.skipcondition.outputs.proceed }} = false ]; then echo "Skipping this step." else git push origin ${{ steps.versionextractor.outputs.version }} fi comment-on-pr: name: Comment on Released PRs needs: [publish-npm, publish-tag] runs-on: ubuntu-latest outputs: pr_number: ${{ steps.get-pr.outputs.pr_number }} changelog_url: ${{ steps.post-comment.outputs.changelog_url }} version: ${{ steps.post-comment.outputs.version }} primary_version: ${{ steps.post-comment.outputs.primary_version }} steps: - name: Get PR Number id: get-pr uses: actions/github-script@v8 with: script: | const deploySha = context.sha; const owner = context.repo.owner; const repo = context.repo.repo; try { const prs = await github.rest.repos.listPullRequestsAssociatedWithCommit({ owner, repo, commit_sha: deploySha }); const mergedPR = prs.data.find(pr => pr.merged_at); if (mergedPR) { core.setOutput('pr_number', String(mergedPR.number)); return; } } catch (error) { console.log(`Failed to discover PR from commit: ${error.message}`); } core.setOutput('pr_number', ''); - name: Post Release Comment on PR id: post-comment if: steps.get-pr.outputs.pr_number != '' uses: actions/github-script@v8 with: script: | const prNumber = parseInt('${{ steps.get-pr.outputs.pr_number }}'); const raw = `${{ needs.publish-npm.outputs.package_versions }}`; const packageVersions = {}; for (const line of raw.split('\n')) { const match = line.match(/^(.+?)\s+=>\s+(.+)$/); if (match) packageVersions[match[1].trim()] = match[2].trim(); } const packageEntries = Object.entries(packageVersions); const version = packageVersions['webex'] ? `v${packageVersions['webex']}` : ''; core.setOutput('version', version); const owner = context.repo.owner; const repo = context.repo.repo; const repoUrl = `https://github.com/${owner}/${repo}`; const hasPackages = packageEntries.length > 0; let commentBody; if (hasPackages) { const primaryPackage = packageVersions['webex'] ? 'webex' : packageEntries[0][0]; const primaryVersion = packageVersions[primaryPackage]; core.setOutput('primary_version', `${primaryPackage}@${primaryVersion}`); const stableVersion = primaryVersion.replace(/-next\..*/, '').replace(/-[a-z]*\..*/, ''); const cnameFile = await github.rest.repos.getContent({ owner, repo, path: 'docs/CNAME' }); const cname = Buffer.from(cnameFile.data.content, 'base64').toString().trim(); const changelogUrl = new URL(`https://${cname}/changelog/`); if (stableVersion) { changelogUrl.searchParams.set('stable_version', stableVersion); } changelogUrl.searchParams.set('package', primaryPackage); changelogUrl.searchParams.set('version', primaryVersion); core.setOutput('changelog_url', changelogUrl.toString()); const releaseLine = version ? `| **Released in:** [\`${version}\`](${repoUrl}/releases/tag/${version}) |` : ''; const rows = packageEntries .sort(([a], [b]) => { if (a === 'webex') return -1; if (b === 'webex') return 1; if (a === primaryPackage) return -1; if (b === primaryPackage) return 1; return a.localeCompare(b); }) .map(([pkg, ver]) => `| \`${pkg}\` | \`${ver}\` |`) .join('\n'); const packagesTable = [ '', '| Packages Updated | Version |', '|---------|---------|', rows, '' ].join('\n'); commentBody = [ '| :tada: Your changes are now available! |', '|---|', releaseLine, `| :book: **[View full changelog →](${changelogUrl})** |`, packagesTable, 'Thank you for your contribution!', '', `_:robot: This is an automated message. For queries, please contact [support](https://developer.webex.com/support)._` ].filter(Boolean).join('\n'); } else { commentBody = [ ':white_check_mark: **Your changes have been merged!**', '', 'Thank you for your contribution!', '', `_:robot: This is an automated message. For queries, please contact [support](https://developer.webex.com/support)._` ].join('\n'); const tagVersion = '${{ needs.publish-tag.outputs.version }}'.trim(); if (tagVersion) { const primaryVersion = tagVersion.replace(/^v/, '') || tagVersion; const primaryPackage = 'webex'; try { const stableVersion = primaryVersion.replace(/-next\..*/, '').replace(/-[a-z]*\..*/, ''); const cnameFile = await github.rest.repos.getContent({ owner, repo, path: 'docs/CNAME' }); const cname = Buffer.from(cnameFile.data.content, 'base64').toString().trim(); const changelogUrl = new URL(`https://${cname}/changelog/`); if (stableVersion) changelogUrl.searchParams.set('stable_version', stableVersion); changelogUrl.searchParams.set('package', primaryPackage); changelogUrl.searchParams.set('version', primaryVersion); core.setOutput('changelog_url', changelogUrl.toString()); } catch (e) { core.warning(`Could not build changelog URL: ${e.message}`); } core.setOutput('primary_version', `${primaryPackage}@${primaryVersion}`); core.setOutput('version', tagVersion); } } try { const pr = await github.rest.pulls.get({ owner, repo, pull_number: prNumber }); if (!pr.data.merged_at) return; const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number: prNumber, per_page: 100 }); const detailedComment = comments.find(comment => comment.user.type === 'Bot' && comment.body.includes('Your changes are now available') ); const mergedComment = comments.find(comment => comment.user.type === 'Bot' && comment.body.includes('Your changes have been merged') ); if (detailedComment) return; if (!hasPackages && mergedComment) return; if (mergedComment && hasPackages) { await github.rest.issues.updateComment({ owner, repo, comment_id: mergedComment.id, body: commentBody }); } else { await github.rest.issues.createComment({ owner, repo, issue_number: prNumber, body: commentBody }); } } catch (error) { core.warning(`Failed to comment on PR #${prNumber}: ${error.message}`); } notify-webex-space: name: Send Webex Space Notification needs: [publish-tag, publish-npm, comment-on-pr] runs-on: ubuntu-latest if: always() steps: - name: Post Webex Space Message env: WEBEX_BOT_TOKEN: ${{ secrets.WEBEX_BOT_TOKEN }} WEBEX_ROOM_ID: ${{ secrets.WEBEX_ROOM_ID }} COMMIT_MESSAGE: ${{ github.event.head_commit.message }} run: | VERSION="${{ needs.comment-on-pr.outputs.primary_version }}" PR_NUMBER="${{ needs.comment-on-pr.outputs.pr_number }}" CHANGELOG_URL="${{ needs.comment-on-pr.outputs.changelog_url }}" if [ -n "${PR_NUMBER}" ]; then PR_LINK="https://github.com/${{ github.repository }}/pull/${PR_NUMBER}" else PR_LINK="" fi PR_TITLE=$(printf '%s' "${COMMIT_MESSAGE}" | head -n 1) MESSAGE="" if [ -n "${VERSION}" ]; then MESSAGE=$(printf '%s' "**Version:** ${VERSION}") fi if [ -n "${PR_LINK}" ]; then PR_BLOCK=$(printf '%s' "**PR:** [${PR_TITLE}](${PR_LINK})") if [ -n "${MESSAGE}" ]; then MESSAGE=$(printf '%s\n\n%s' "${MESSAGE}" "${PR_BLOCK}") else MESSAGE="${PR_BLOCK}" fi fi if [ -n "${CHANGELOG_URL}" ]; then CL_BLOCK=$(printf '%s' "**Changelog:** ${CHANGELOG_URL}") if [ -n "${MESSAGE}" ]; then MESSAGE=$(printf '%s\n\n%s' "${MESSAGE}" "${CL_BLOCK}") else MESSAGE="${CL_BLOCK}" fi fi if [ -z "${MESSAGE}" ]; then echo "No version or PR info available. Skipping notification." exit 0 fi echo "Sending message to Webex Space..." BODY=$(jq -n --arg room "${WEBEX_ROOM_ID}" --arg md "${MESSAGE}" '{roomId: $room, markdown: $md}') curl -sSf \ -H "Authorization: Bearer ${WEBEX_BOT_TOKEN}" \ -H "Content-Type: application/json" \ -d "${BODY}" \ https://webexapis.com/v1/messages > /dev/null echo "Message sent successfully!"