@i-santos/create-package-starter 1.4.0 → 1.5.0-beta.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i-santos/create-package-starter",
-  "version": "1.4.0",
+  "version": "1.5.0-beta.10",
   "description": "Scaffold new npm packages with a standardized Changesets release workflow",
   "license": "MIT",
   "author": "Igor Santos",

package/template/.github/PULL_REQUEST_TEMPLATE.md

@@ -2,14 +2,9 @@
 
 - 
 
-## Validation
+## Checklist
 
-- [ ] `npm run check`
-- [ ] `npm run changeset` (if release-impacting)
-
-## Release Notes
-
-- [ ] No release impact
-- [ ] Patch
-- [ ] Minor
-- [ ] Major
+- [ ] I ran `npm run check`
+- [ ] I added/updated tests when needed
+- [ ] I updated docs/README if behavior changed
+- [ ] I added a changeset for publishable changes

package/template/.github/workflows/auto-retarget-pr.yml

@@ -0,0 +1,57 @@
+name: Auto Retarget PR Base
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - edited
+      - ready_for_review
+
+permissions:
+  pull-requests: write
+
+concurrency:
+  group: pr-retarget-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  retarget:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Retarget pull request base branch
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const pr = context.payload.pull_request;
+            if (!pr) {
+              core.info('No pull_request payload. Skipping.');
+              return;
+            }
+
+            const head = pr.head.ref;
+            const currentBase = pr.base.ref;
+            const stableBase = '__DEFAULT_BRANCH__';
+            const betaBase = '__BETA_BRANCH__';
+
+            let desiredBase = currentBase;
+            if (head === betaBase) {
+              desiredBase = stableBase;
+            } else {
+              desiredBase = betaBase;
+            }
+
+            if (desiredBase === currentBase) {
+              core.info(`No retarget needed for #${pr.number} (head: ${head}, base: ${currentBase}).`);
+              return;
+            }
+
+            await github.rest.pulls.update({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: pr.number,
+              base: desiredBase
+            });
+
+            core.notice(`Retargeted PR #${pr.number} base from "${currentBase}" to "${desiredBase}".`);

package/template/.github/workflows/ci.yml

@@ -5,6 +5,7 @@ on:
   push:
     branches:
       - __DEFAULT_BRANCH__
+      - __BETA_BRANCH__
 
 jobs:
   check:
@@ -27,3 +28,17 @@ jobs:
 
       - name: Check
         run: npm run check
+
+  required-check:
+    name: required-check
+    runs-on: ubuntu-latest
+    needs:
+      - check
+    if: ${{ always() }}
+    steps:
+      - name: Validate matrix result
+        run: |
+          if [ "${{ needs.check.result }}" != "success" ]; then
+            echo "check matrix failed"
+            exit 1
+          fi

package/template/.github/workflows/promote-stable.yml

@@ -0,0 +1,103 @@
+name: Promote Stable
+
+on:
+  workflow_dispatch:
+    inputs:
+      promote_type:
+        description: Promotion bump type
+        required: true
+        default: patch
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+      summary:
+        description: Promotion changeset summary
+        required: true
+        default: Promote beta track to stable release.
+      target_beta_branch:
+        description: Target beta branch
+        required: true
+        default: __BETA_BRANCH__
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  promote:
+    runs-on: ubuntu-latest
+    outputs:
+      promotion_branch: ${{ steps.prepare.outputs.promotion_branch }}
+      promotion_pr_number: ${{ steps.pr.outputs.pull-request-number }}
+      promotion_pr_url: ${{ steps.pr.outputs.pull-request-url }}
+    steps:
+__RELEASE_AUTH_APP_STEP__
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: __RELEASE_AUTH_CHECKOUT_TOKEN__
+          ref: ${{ github.event.inputs.target_beta_branch }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install
+        run: npm ci
+
+      - name: Prepare promotion branch
+        id: prepare
+        run: |
+          promotion_branch="promote/stable-$(date +%s)"
+          echo "promotion_branch=$promotion_branch" >> "$GITHUB_OUTPUT"
+          git checkout -b "$promotion_branch"
+
+      - name: Exit prerelease mode
+        run: npm run beta:exit
+
+      - name: Create promotion changeset
+        run: |
+          mkdir -p .changeset
+          file=".changeset/promote-stable-${{ github.run_id }}.md"
+          cat > "$file" <<EOF
+          ---
+          "__PACKAGE_NAME__": ${{ github.event.inputs.promote_type }}
+          ---
+
+          ${{ github.event.inputs.summary }}
+          EOF
+
+      - name: Commit and push
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add .changeset
+          git commit -m "chore: promote beta to stable"
+          git push --set-upstream origin "${{ steps.prepare.outputs.promotion_branch }}"
+
+      - name: Open promotion PR
+        id: pr
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: __RELEASE_AUTH_GITHUB_TOKEN__
+          base: ${{ github.event.inputs.target_beta_branch }}
+          branch: ${{ steps.prepare.outputs.promotion_branch }}
+          title: "chore: promote beta to stable"
+          body: |
+            ## Summary
+            - Exit prerelease mode (`changeset pre exit`)
+            - Add stable promotion changeset
+            - Prepare stable release flow from `${{ github.event.inputs.target_beta_branch }}`
+          draft: false
+
+      - name: Enable auto-merge
+        if: steps.pr.outputs.pull-request-number != ''
+        run: gh pr merge "${{ steps.pr.outputs.pull-request-number }}" --repo "${{ github.repository }}" --squash --auto
+        env:
+          GH_TOKEN: __RELEASE_AUTH_GITHUB_TOKEN__

package/template/.github/workflows/release.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - __DEFAULT_BRANCH__
+      - __BETA_BRANCH__
 
 permissions:
   contents: write
@@ -14,10 +15,13 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
+__RELEASE_AUTH_APP_STEP__
+
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          token: __RELEASE_AUTH_CHECKOUT_TOKEN__
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -26,6 +30,9 @@ jobs:
           cache: npm
           registry-url: https://registry.npmjs.org
 
+      - name: Setup npm (latest)
+        run: npm install -g npm@latest
+
       - name: Install
         run: npm ci
 
@@ -40,4 +47,5 @@ jobs:
           title: "chore: release packages"
           commit: "chore: release packages"
         env:
-          GITHUB_TOKEN: ${{ secrets.CHANGESETS_GH_TOKEN || secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: __RELEASE_AUTH_GITHUB_TOKEN__
+          NODE_AUTH_TOKEN: ""

package/template/CONTRIBUTING.md

@@ -12,6 +12,14 @@
 3. `.github/workflows/release.yml` opens/updates `chore: release packages`.
 4. Merge the release PR to publish.
 
+## Beta process
+
+1. Use branch `__BETA_BRANCH__` for prereleases.
+2. Run `npm run beta:enter` once on `__BETA_BRANCH__`.
+3. Publish beta versions via `.github/workflows/release.yml` on `__BETA_BRANCH__`.
+4. Run `npm run beta:promote` to exit prerelease mode and create stable promotion changeset.
+5. Open PR from `__BETA_BRANCH__` to `__DEFAULT_BRANCH__`.
+
 ## Trusted Publishing
 
 If the package does not exist on npm yet, the first publish can be manual:

package/template/README.md

@@ -8,6 +8,10 @@ Package created by `@i-santos/create-package-starter`.
 - `npm run changeset`
 - `npm run version-packages`
 - `npm run release`
+- `npm run beta:enter`
+- `npm run beta:exit`
+- `npm run beta:publish`
+- `npm run beta:promote`
 
 ## Release flow
 
@@ -16,6 +20,13 @@ Package created by `@i-santos/create-package-starter`.
 3. `.github/workflows/release.yml` creates or updates `chore: release packages`.
 4. Merge the release PR to publish.
 
+## Beta release flow
+
+1. Create `__BETA_BRANCH__` from `__DEFAULT_BRANCH__`.
+2. Run `npm run beta:enter` once on `__BETA_BRANCH__`.
+3. Push updates to `__BETA_BRANCH__` and let `.github/workflows/release.yml` publish beta versions.
+4. When ready for stable, run `npm run beta:promote`, open PR from `__BETA_BRANCH__` to `__DEFAULT_BRANCH__`, and merge.
+
 ## Trusted Publishing
 
 If this package does not exist on npm yet, first publish can be manual:

package/template/gitignore

@@ -0,0 +1,24 @@
+node_modules/
+dist/
+build/
+coverage/
+.turbo/
+.cache/
+tmp/
+temp/
+
+.DS_Store
+Thumbs.db
+
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+.env
+.env.*
+!.env.example
+!.env.*.example
+
+.npmrc

package/template/package.json

@@ -6,7 +6,12 @@
     "check": "node scripts/check.js",
     "changeset": "changeset",
     "version-packages": "changeset version",
-    "release": "npm run check && changeset publish"
+    "release": "npm run check && changeset publish",
+    "beta:enter": "changeset pre enter beta",
+    "beta:exit": "changeset pre exit",
+    "beta:version": "changeset version",
+    "beta:publish": "changeset publish",
+    "beta:promote": "create-package-starter promote-stable --dir ."
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.7"