ci: always preview versions (#357)

* ci: always preview versions

* Update comment wording

* Add changeset

* More testing

* Update peerDep

* Fix

* Undo test changes

Author: lachlancollins

.github/changeset-preview/preview-changeset-versions.mjs

@@ -89,11 +89,12 @@ function main() {
   const explicit = readChangesetEntries()
 
   if (explicit.size === 0) {
-    const msg = 'No changeset entries found — nothing to preview.\n'
+    const msg =
+      'No changeset entries found. Merging this PR will not cause a version bump for any packages.\n'
+    process.stdout.write(msg)
     if (values.output) {
       writeFileSync(values.output, msg)
-    } else {
-      process.stdout.write(msg)
+      process.stdout.write(`Written to ${values.output}\n`)
     }
     return
   }
@@ -138,12 +139,11 @@ function main() {
 
   // 7. Build markdown
   const lines = []
-  lines.push('<!-- changeset-version-preview -->')
-  lines.push('## Changeset Version Preview')
-  lines.push('')
 
   if (bumps.length === 0) {
-    lines.push('No version changes detected.')
+    lines.push(
+      'No version changes detected. Merging this PR will not cause a version bump for any packages.',
+    )
   } else {
     const explicitBumps = bumps.filter((b) => b.source !== 'dependency')
     const dependencyBumps = bumps.filter((b) => b.source === 'dependency')
@@ -184,13 +184,12 @@ function main() {
   }
 
   lines.push('')
-
   const md = lines.join('\n')
+
+  process.stdout.write(md)
   if (values.output) {
     writeFileSync(values.output, md)
     process.stdout.write(`Written to ${values.output}\n`)
-  } else {
-    process.stdout.write(md)
   }
 }
 

.github/changeset-preview/upsert-pr-comment.mjs

@@ -4,7 +4,7 @@ import { promises as fsp } from 'node:fs'
 import path from 'node:path'
 import { parseArgs as parseNodeArgs } from 'node:util'
 
-const DEFAULT_MARKER = '<!-- bundle-size-benchmark -->'
+const DEFAULT_MARKER = '<!-- changeset-version-preview -->'
 
 function parseArgs(argv) {
   const { values } = parseNodeArgs({
@@ -109,9 +109,9 @@ async function main() {
   const args = parseArgs(process.argv.slice(2))
   const bodyPath = path.resolve(args.bodyFile)
   const rawBody = await fsp.readFile(bodyPath, 'utf8')
-  const body = rawBody.includes(args.marker)
-    ? rawBody
-    : `${args.marker}\n${rawBody}`
+  const body = `${args.marker}\n## 🚀 Changeset Version Preview\n\n${rawBody}`
+
+  process.stdout.write(body)
 
   const comments = await listIssueComments({
     apiUrl: args.apiUrl,

.github/workflows/changeset-preview.yml

@@ -2,8 +2,6 @@ name: Changeset Preview
 
 on:
   pull_request:
-    paths:
-      - '.changeset/**'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.number || github.ref }}