refactor: 💡 extended validation step condition to latest #6
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: 🎯 Monorepo Package Publisher (NPM) | ||
|
Check failure on line 1 in .github/workflows/monorepo-package-release.yml
|
||
| # TODO: Create release workflow as this is a concurrent NPM publisher to the original changeset based workflow for Click UI | ||
| # which is much stricter with a very particular | ||
| # release cycle: test or release-candidate -> stable -> latest | ||
| # The "Monorepo Package Publisher" initial version is not strict | ||
| # and relies on the user managing the changeset state | ||
| # e.g. enter/leave pre-release mode as needed (`yarn workspace @clickhouse/design-tokens changeset pre enter <tag>` / `changeset pre exit`), run `yarn workspace @clickhouse/design-tokens changeset version` to bump the version and generate the changelog, ensure the version bump and changelog are committed in the branch/commit you intend to release | ||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| package: | ||
| description: 'Package to release' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| # NOTE: Declare the package names | ||
| # that can be published to NPM registry | ||
| - design-tokens | ||
| release_type: | ||
| description: 'Release type' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - test | ||
| - rc | ||
| - stable | ||
| - latest | ||
| default: 'test' | ||
| confirm_package: | ||
| description: 'Type the package name to confirm (e.g., "design-tokens")' | ||
| required: true | ||
| type: string | ||
| confirm_branch: | ||
| description: 'For stable and latest releases: type the branch name (e.g., "main")' | ||
| required: false | ||
| type: string | ||
| dry_run: | ||
| description: 'Dry run (e.g., skip publish, github release, and slack notification)' | ||
| required: true | ||
| type: boolean | ||
| default: true | ||
| concurrency: ${{ github.workflow }}-${{ github.ref }} | ||
| env: | ||
| HUSKY: 0 | ||
| jobs: | ||
| monorepo-release-package: | ||
| name: Monorepo Release Package | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| id-token: write | ||
| steps: | ||
| - name: Validate package confirmation | ||
| env: | ||
| INPUT_PACKAGE: ${{ inputs.package }} | ||
| INPUT_CONFIRM_PACKAGE: ${{ inputs.confirm_package }} | ||
| run: | | ||
| if [[ "$INPUT_PACKAGE" != "$INPUT_CONFIRM_PACKAGE" ]]; then | ||
| echo "👹 Oops! Package confirmation mismatch!" | ||
| echo " Selected: '$INPUT_PACKAGE'" | ||
| echo " Typed: '$INPUT_CONFIRM_PACKAGE'" | ||
| echo "" | ||
| echo "💡 Please type the exact package name to confirm." | ||
| exit 1 | ||
| fi | ||
| echo "✅ Package confirmed: $INPUT_PACKAGE" | ||
| - name: Validate branch for stable and latest release | ||
| if: inputs.release_type == 'stable' || inputs.release_type == 'latest' | ||
| env: | ||
| INPUT_RELEASE_TYPE: ${{ inputs.release_type }} | ||
| INPUT_CONFIRM_BRANCH: ${{ inputs.confirm_branch }} | ||
| CURRENT_BRANCH: ${{ github.ref_name }} | ||
| run: | | ||
| if [[ -z "$INPUT_CONFIRM_BRANCH" ]]; then | ||
| echo "👹 Oops! Branch confirmation required for $INPUT_RELEASE_TYPE releases!" | ||
| echo " Current branch: '$CURRENT_BRANCH'" | ||
| echo "" | ||
| echo "💡 Please type the branch name in 'confirm_branch' to proceed." | ||
| exit 1 | ||
| fi | ||
| if [[ "$CURRENT_BRANCH" != "$INPUT_CONFIRM_BRANCH" ]]; then | ||
| echo "👹 Oops! Branch confirmation mismatch!" | ||
| echo " Current branch: '$CURRENT_BRANCH'" | ||
| echo " Typed: '$INPUT_CONFIRM_BRANCH'" | ||
| echo "" | ||
| echo "💡 Please type the exact branch name to confirm." | ||
| exit 1 | ||
| fi | ||
| if [[ "$CURRENT_BRANCH" != "main" ]]; then | ||
| echo "👹 Oops! $INPUT_RELEASE_TYPE releases must be from 'main' branch!" | ||
| echo " Current branch: '$CURRENT_BRANCH'" | ||
| exit 1 | ||
| fi | ||
| echo "✅ Branch confirmed: $CURRENT_BRANCH" | ||
| - name: Generate GitHub workflow token | ||
| if: ${{ !inputs.dry_run }} | ||
| id: gh-workflow-token | ||
| uses: actions/create-github-app-token@v2 | ||
| with: | ||
| app-id: ${{ secrets.WORKFLOW_AUTH_PUBLIC_APP_ID }} | ||
| private-key: ${{ secrets.WORKFLOW_AUTH_PUBLIC_PRIVATE_KEY }} | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 0 | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v6 | ||
| with: | ||
| node-version: '23.x' | ||
| registry-url: 'https://registry.npmjs.org' | ||
| - name: Upgrade npm for OIDC support | ||
| run: | | ||
| npm install -g npm@latest | ||
| echo "npm version: $(npm --version)" | ||
| - name: Enable Corepack | ||
| run: corepack enable | ||
| - name: Install dependencies | ||
| run: yarn install --frozen-lockfile | ||
| - name: Load package configuration | ||
| id: package-config | ||
| env: | ||
| INPUT_PACKAGE: ${{ inputs.package }} | ||
| run: | | ||
| PKG_DIR="packages/$INPUT_PACKAGE" | ||
| if [[ ! -f "$PKG_DIR/package.json" ]]; then | ||
| echo "👹 Oops! No package.json found at $PKG_DIR" | ||
| exit 1 | ||
| fi | ||
| PKG_NAME=$(node -p "require('./$PKG_DIR/package.json').name") | ||
| echo "package_name=$PKG_NAME" >> $GITHUB_OUTPUT | ||
| echo "package_path=$PKG_DIR" >> $GITHUB_OUTPUT | ||
| echo "changelog_file=CHANGELOG.md" >> $GITHUB_OUTPUT | ||
| echo "✅ Loaded config for $PKG_NAME ($PKG_DIR)" | ||
| - name: Build package | ||
| working-directory: ${{ steps.package-config.outputs.package_path }} | ||
| run: yarn build | ||
| - name: Get version from package.json | ||
| id: package-version | ||
| working-directory: ${{ steps.package-config.outputs.package_path }} | ||
| run: | | ||
| VERSION=$(node -p "require('./package.json').version") | ||
| echo "version=$VERSION" >> $GITHUB_OUTPUT | ||
| echo "📦 Package version: $VERSION" | ||
| - name: Check version on npm | ||
| if: ${{ !inputs.dry_run }} | ||
| run: | | ||
| PKG_NAME="${{ steps.package-config.outputs.package_name }}" | ||
| VERSION="${{ steps.package-version.outputs.version }}" | ||
| echo "🔍 Checking if $PKG_NAME@$VERSION already exists on NPM..." | ||
| if npm view "$PKG_NAME@$VERSION" version 2>/dev/null; then | ||
| echo "👹 Oops! Version $VERSION of $PKG_NAME is already published on NPM!" | ||
| echo "💡 Please bump the version via changesets and try again." | ||
| exit 1 | ||
| fi | ||
| echo "✅ Version $VERSION is not yet published, safe to proceed." | ||
| - name: Publish to npm over OpenID Connect (OIDC) | ||
| working-directory: ${{ steps.package-config.outputs.package_path }} | ||
| run: | | ||
| if [[ "${{ inputs.dry_run }}" == "true" ]]; then | ||
| echo "🧪 Dry run mode — publishing with --dry-run" | ||
| npm publish \ | ||
| --access public \ | ||
| --provenance \ | ||
| --tag ${{ inputs.release_type }} \ | ||
| --dry-run | ||
| else | ||
| npm publish \ | ||
| --access public \ | ||
| --provenance \ | ||
| --tag ${{ inputs.release_type }} | ||
| fi | ||
| - name: Extract changelog | ||
| if: ${{ !inputs.dry_run }} | ||
| id: changelog | ||
| run: | | ||
| VERSION="${{ steps.package-version.outputs.version }}" | ||
| PKG_PATH="${{ steps.package-config.outputs.package_path }}" | ||
| CHANGELOG_FILE="${{ steps.package-config.outputs.changelog_file }}" | ||
| CHANGELOG_PATH="${PKG_PATH}/${CHANGELOG_FILE}" | ||
| if [[ -f "$CHANGELOG_PATH" ]]; then | ||
| CHANGELOG=$(awk "/## $VERSION/,/## [0-9]/" "$CHANGELOG_PATH" | sed '1d;$d' | sed '/^$/d') | ||
| if [[ -z "$CHANGELOG" ]]; then | ||
| CHANGELOG="📝 See [CHANGELOG.md](./$CHANGELOG_FILE) for details." | ||
| fi | ||
| else | ||
| CHANGELOG="No changelog available." | ||
| fi | ||
| echo "$CHANGELOG" > /tmp/changelog.txt | ||
| echo "📄 Extracted changelog" | ||
| - name: Create GitHub release | ||
| if: ${{ !inputs.dry_run }} | ||
| uses: softprops/action-gh-release@v1 | ||
| with: | ||
| tag_name: ${{ steps.package-config.outputs.package_name }}@v${{ steps.package-version.outputs.version }} | ||
| name: "${{ inputs.package }} v${{ steps.package-version.outputs.version }}" | ||
| body_path: /tmp/changelog.txt | ||
| prerelease: ${{ inputs.release_type == 'test' || inputs.release_type == 'rc' }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ steps.gh-workflow-token.outputs.token }} | ||
| - name: Notify Slack about new release | ||
| if: ${{ !inputs.dry_run && secrets.SLACK_BOT_TOKEN != '' }} | ||
| uses: slackapi/slack-github-action@v2.1.1 | ||
| with: | ||
| method: chat.postMessage | ||
| token: ${{ secrets.SLACK_BOT_TOKEN }} | ||
| payload: | | ||
| channel: "${{ secrets.SLACK_CHANNEL_FOR_GENERAL }}" | ||
| text: "===\n🚀 *${{ steps.package-config.outputs.package_name }}* v${{ steps.package-version.outputs.version }} released to npm!\n\n📦 <https://www.npmjs.com/package/${{ steps.package-config.outputs.package_name }}/v/${{ steps.package-version.outputs.version }}|View on npm>\n🏷️ Tag: `${{ inputs.release_type }}`\n===" | ||
