v0.0.13

- Add `global_install` to show global npm installation instructions on the generated GitHub comment.
- Add `github_comment_included_packages` to allow including just some packages on the generated GitHub comment.
- Rename `custom_message` to `custom_message_prefix`
- Add `custom_message_suffix`

Co-Authored-By: Sam Rose <11774595+sam-b-rose@users.noreply.github.com>
Co-Authored-By: aveline <aveline@users.noreply.github.com>
Co-Authored-By: Isaac Roldán <isaac.roldan@gmail.com>

Author: 4 people

README.md

@@ -93,12 +93,45 @@ The comment to write to trigger the creation of a snapshot.
 
 Push the changes to a branch instead of publishing to the NPM registry.
 
-**`custom_message` (optional)**
+**`custom_message_prefix` (optional)**
 
 Custom message to added to the beginning of the release GitHub comment.
+By default a generic message is shown: "Test the snapshots by updating your package.json with the newly published versions:"
+
+**`custom_message_suffix` (optional)**
+
+Custom message to added to the end of the release GitHub comment.
+
+**`global_install` (optional)**
+
+If true, the generated GitHub comment will show the command to install your packages globally.
+Otherwise, the default behaviour is to show a json example to update your local dependencies.
+
+**`github_comment_included_packages` (optional)**
+
+In workspaces where many packages are deployed, use this filter if you only want to include some of them in the release GitHub comment.
+(To specify multiple packages, separate using commas)
+
+## Contributing
+
+To contribute a change, bug fix or feature to snapit:
+
+1. Make a new branch `my-branch`
+1. Make the changes you need
+1. Run `pnpm build`
+1. Push your changes to the branch
+1. In your repositories `main` branch point the `.github/snapit.yml` file to the `shopify/snapit` branch `uses: Shopify/snapit@my-branch`
+1. Create a pull request with changeset and write `/snapit` as a comment in the pull request
 
 ## Changelog
 
+**`v0.0.13`**
+
+- Add `global_install` to show global npm installation instructions on the generated GitHub comment.
+- Add `github_comment_included_packages` to allow including just some packages on the generated GitHub comment.
+- Rename `custom_message` to `custom_message_prefix`
+- Add `custom_message_suffix`
+
 **`v0.0.12`**
 
 - Fix typo in snapshot comment message

action.yml

@@ -9,8 +9,15 @@ inputs:
     default: '/snapit'
   branch:
     description: Push the changes to a branch instead of publishing to the NPM registry.
-  custom_message:
-    description: Custom message to added to the beginning of the release GitHub comment.
+  custom_message_prefix:
+    description: Custom message added to the beginning of the snapit GitHub comment. By default a generic message is shown.
+  custom_message_suffix:
+    description: Custom message added to the end of the snapit GitHub comment.
+  global_install:
+    description: If true, the GitHub comment will show instructions to install a global npm package instead of the normal JSON dependencies.
+  github_comment_included_packages:
+    description: Which packages to include in the final output. All pacakges are still published, but only those in this list are shown in the final message. If empty, all packages are included.
+
 runs:
   using: node20
   main: dist/index.js

dist/index.js

@@ -31,15 +31,21 @@ try {
   };
 
   const buildScript = core.getInput('build_script');
+  const isGlobal = core.getInput('global_install') === 'true';
+  const githubCommentIncludedPackages = core.getInput(
+    'github_comment_included_packages',
+  );
   const branch = core.getInput('branch');
+  const customMessagePrefix = core.getInput('custom_message_prefix');
+  const customMessageSuffix = core.getInput('custom_message_suffix');
+  const commentCommands = core.getInput('comment_command');
   const octokit = github.getOctokit(process.env.GITHUB_TOKEN);
   const isYarn = existsSync('yarn.lock');
   const isPnpm = existsSync('pnpm-lock.yaml');
   const changesetBinary = path.join('node_modules/.bin/changeset');
   const versionPrefix = 'snapshot';
 
-  const commentCommands = core.getInput('comment_command').split(',');
-  if (commentCommands.indexOf(payload.comment.body) !== -1) {
+  if (commentCommands.split(',').indexOf(payload.comment.body) !== -1) {
     await octokit.rest.reactions.createForIssueComment({
       ...ownerRepo,
       comment_id: payload.comment.id,
@@ -113,18 +119,33 @@ try {
     await exec(changesetBinary, ['version', '--snapshot', versionPrefix]);
 
     const {packages} = await getPackages(process.cwd());
-    const snapshots = [];
+
+    interface Snapshot {
+      package: string;
+      version: string;
+      timestamp: string;
+      fullString: string;
+    }
+
+    const snapshots: Snapshot[] = [];
     packages.forEach(({packageJson}) => {
       const {name, version, private: isPrivate} = packageJson;
-      if (name && version && !isPrivate && version.includes(versionPrefix))
-        snapshots.push(`${name}@${version}`);
+      if (name && version && !isPrivate && version.includes(versionPrefix)) {
+        const timestamp = version.split('-').at(-1);
+        snapshots.push({
+          package: name,
+          version,
+          timestamp,
+          fullString: `${name}@${version}`,
+        });
+      }
     });
 
     if (!snapshots.length) {
       throw new Error('Changeset publish did not create new tags.');
     }
 
-    const snapshotTimestamp = snapshots[0].split('-').at(-1);
+    const snapshotTimestamp = snapshots[0].timestamp;
 
     // Run after `changeset version` so build scripts can use updated versions
     if (buildScript) {
@@ -183,31 +204,49 @@ try {
       ]);
     }
 
-    const multiple = snapshots.length > 1;
+    const filteredSnapshots = githubCommentIncludedPackages
+      ? snapshots.filter((snapshot: Snapshot) =>
+          githubCommentIncludedPackages
+            .split(',')
+            .some((filter) => snapshot.package === filter),
+        )
+      : snapshots;
+    const multiple = filteredSnapshots.length > 1;
 
     const introMessage = branch
       ? `Your snapshot${multiple ? 's are' : ' is'} being published.**\n\n`
       : `Your snapshot${multiple ? 's have' : ' has'} been published to npm.**\n\n`;
 
-    const customMessage = core.getInput('custom_message');
+    const globalInstallMessage = isYarn
+      ? 'yarn global add'
+      : isPnpm
+        ? 'pnpm i -g'
+        : 'npm i -g';
 
-    const body =
-      `🫰✨ **Thanks @${payload.comment.user.login}! ${introMessage}` +
-      `${customMessage ? `${customMessage} ` : ''}` +
-      `Test the snapshot${
-        multiple ? 's' : ''
-      } by updating your \`package.json\` ` +
-      `with the newly published version${multiple ? 's' : ''}:\n` +
+    const globalPackagesMessage =
+      '```bash\n' +
+      filteredSnapshots
+        .map((pkg) => `${globalInstallMessage} ${pkg.fullString}`)
+        .join('\n') +
+      '\n```';
+
+    const localDependenciesMessage =
       '```json\n' +
-      snapshots
-        .map((tag) =>
-          tag.startsWith('@')
-            ? `"@${tag.substring(1).split('@')[0]}": "${tag.substring(1).split('@')[1]}"`
-            : `"${tag.split('@')[0]}": "${tag.split('@')[1]}"`,
-        )
+      filteredSnapshots
+        .map((tag) => `"${tag.package}": "${tag.version}"`)
         .join(',\n') +
       '\n```';
 
+    const defaultMessage = isGlobal
+      ? `Test the snapshot by intalling your package globally:`
+      : `Test the snapshot${multiple ? 's' : ''} by updating your \`package.json\` with the newly published version${multiple ? 's' : ''}:`;
+
+    const body =
+      `🫰✨ **Thanks @${payload.comment.user.login}! ${introMessage}` +
+      `${customMessagePrefix ? customMessagePrefix + '  ' : ''}${defaultMessage}\n` +
+      `${isGlobal ? `${globalPackagesMessage}` : `${localDependenciesMessage}`}` +
+      `${customMessageSuffix ? `\n\n${customMessageSuffix}` : ''}`;
+
     await octokit.rest.issues.createComment({
       ...ownerRepo,
       issue_number: payload.issue.number,

index.ts

@@ -1,7 +1,7 @@
 {
   "name": "snapit",
   "private": true,
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Create a snapshot NPM release with `/snapit` comment in a PR",
   "type": "module",
   "scripts": {