Update GitHub Action Inputs to be more cohesive (#32)

Author: alex-page

README.md

@@ -37,7 +37,7 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         with:
           build_script: pnpm build # Optional
-          comment_command: /snapit # Default value not required
+          trigger_comment: /snapit # Default value not required
 ```
 
 **Deploy to branch**
@@ -66,7 +66,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           branch: snapshot-release
-          comment_command: /snapit # Default value not required
+          trigger_comment: /snapit # Default value not required
 ```
 
 ## Environment Variables
@@ -79,20 +79,20 @@ The `GITHUB_TOKEN` is needed for changesets to look up the current changeset whe
 
 A `NPM_TOKEN` needs to be created and added to the repository to [publish packages from GitHub actions to the npm registry](https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages#publishing-packages-to-the-npm-registry).
 
-## Action workflow options
-
-| Option                             | Default                  | Description                                                                                                                                                          |
-| ---------------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `build_script`                     | -                        | The build script to run before publishing.                                                                                                                           |
-| `comment_command`                  | `/snapit`                | The comment to write to trigger the creation of a snapshot.                                                                                                          |
-| `branch`                           | -                        | Push the changes to a branch instead of publishing to the NPM registry.                                                                                              |
-| `custom_message_prefix`            | -                        | Custom message to add to the beginning of the release GitHub comment. Default: "Test the snapshots by updating your package.json with the newly published versions:" |
-| `custom_message_suffix`            | -                        | Custom message to add to the end of the release GitHub comment.                                                                                                      |
-| `global_install`                   | `false`                  | If true, the generated GitHub comment will show the command to install your packages globally. Otherwise, shows a JSON example to update local dependencies.         |
-| `github_comment_included_packages` | -                        | Filter to include specific packages in the release GitHub comment. Separate multiple packages with commas.                                                           |
-| `working_directory`                | -                        | If specified, the action will run all commands for snapit in the specified directory.                                                                                |
-| `post_install_script`              | -                        | If specified, will run a script after dependencies are installed.                                                                                                    |
-| `release_branch`                   | `changeset-release/main` | If specified, will use this branch name in place of the default                                                                                                      |
+## GitHub Action Inputs
+
+| Inputs (All Optional) | Description                                                                                                                                                          |
+| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `trigger_comment`     | Default: `/snapit`. Comma seperated list of comments to write to trigger the creation of a snapshot.                                                                 |
+| `comment_prefix`      | Custom message to add to the beginning of the release GitHub comment. Default: "Test the snapshots by updating your package.json with the newly published versions:" |
+| `comment_suffix`      | Custom message to add to the end of the release GitHub comment.                                                                                                      |
+| `comment_packages`    | Filter to include specific packages in the release GitHub comment. Separate multiple packages with commas.                                                           |
+| `comment_is_global`   | If true, the generated GitHub comment will show the command to install your packages globally. Otherwise, shows a JSON example to update local dependencies.         |
+| `cwd`                 | If specified, the action will run all commands for snapit in the specified directory.                                                                                |
+| `branch`              | Push the changes to a branch instead of publishing to the NPM registry.                                                                                              |
+| `post_install_script` | If specified, will run a script after dependencies are installed.                                                                                                    |
+| `build_script`        | The build script to run before publishing.                                                                                                                           |
+| `release_branch`      | Default: `changeset-release/main`. If specified, will use this branch name in place of the default                                                                   |
 
 ## Contributing
 

action.yml

@@ -2,25 +2,25 @@ name: snapit-release
 description: Create a snapshot NPM release with `/snapit` comment in a PR
 author: Shopify
 inputs:
-  build_script:
-    description: Build script for building the repository before publishing.
-  post_install_script:
-    description: Script to run after dependencies are installed.
-  comment_command:
+  trigger_comment:
     description: A comma seperated list of comment commands to trigger the action
     default: '/snapit'
-  branch:
-    description: Push the changes to a branch instead of publishing to the NPM registry.
-  custom_message_prefix:
+  comment_prefix:
     description: Custom message added to the beginning of the snapit GitHub comment. By default a generic message is shown.
-  custom_message_suffix:
+  comment_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:
+  comment_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.
-  working_directory:
+  comment_is_global:
+    description: If true, the generated GitHub comment will show the command to install your packages globally. Otherwise, shows a JSON example to update local dependencies.
+  cwd:
     description: If specified, the action will run all commands for snapit in the specified directory.
+  branch:
+    description: Push the changes to a branch instead of publishing to the NPM registry.
+  build_script:
+    description: Build script for building the repository before publishing.
+  post_install_script:
+    description: Script to run after dependencies are installed.
   release_branch:
     description: If specified, will use this branch name in place of the default `changeset-release/main` branch.
     default: 'changeset-release/main'

dist/index.js

@@ -30,31 +30,29 @@ try {
     repo: payload.repository.name,
   };
 
+  const branch = core.getInput('branch');
+  const commentCommand = core.getInput('comment_command');
+  const commentPrefix = core.getInput('commment_prefix');
+  const commentSuffix = core.getInput('commment_suffix');
+  const commentIsGlobal = core.getInput('comment_is_global') === 'true';
   const postInstallScript = core.getInput('post_install_script');
   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 workingDirectory = core.getInput('working_directory');
-  const customMessagePrefix = core.getInput('custom_message_prefix');
-  const customMessageSuffix = core.getInput('custom_message_suffix');
-  const commentCommands = core.getInput('comment_command');
+  const commentPackages = core.getInput('comment_packages');
+  const cwd = core.getInput('cwd');
   const octokit = github.getOctokit(process.env.GITHUB_TOKEN);
   const releaseBranch =
     core.getInput('release_branch') ?? 'changeset-release/main';
 
-  if (workingDirectory) {
-    process.chdir(workingDirectory);
+  if (cwd) {
+    process.chdir(cwd);
   }
 
   const isYarn = existsSync('yarn.lock');
   const isPnpm = existsSync('pnpm-lock.yaml');
   const changesetBinary = path.join('node_modules/.bin/changeset');
   const versionPrefix = 'snapshot';
 
-  if (commentCommands.split(',').indexOf(payload.comment.body) !== -1) {
+  if (commentCommand.split(',').indexOf(payload.comment.body) !== -1) {
     await octokit.rest.reactions.createForIssueComment({
       ...ownerRepo,
       comment_id: payload.comment.id,
@@ -214,9 +212,9 @@ try {
       ]);
     }
 
-    const filteredSnapshots = githubCommentIncludedPackages
+    const filteredSnapshots = commentPackages
       ? snapshots.filter((snapshot: Snapshot) =>
-          githubCommentIncludedPackages
+          commentPackages
             .split(',')
             .some((filter) => snapshot.package === filter),
         )
@@ -247,15 +245,15 @@ try {
         .join(',\n') +
       '\n```';
 
-    const defaultMessage = isGlobal
+    const defaultMessage = commentIsGlobal
       ? `Test the snapshot by installing 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}` : ''}`;
+      `${commentPrefix ? commentPrefix + '  ' : ''}${defaultMessage}\n` +
+      `${commentIsGlobal ? `${globalPackagesMessage}` : `${localDependenciesMessage}`}` +
+      `${commentSuffix ? `\n\n${commentSuffix}` : ''}`;
 
     await octokit.rest.issues.createComment({
       ...ownerRepo,

index.ts

@@ -39,5 +39,6 @@
     "singleQuote": true,
     "bracketSpacing": false,
     "trailingComma": "all"
-  }
+  },
+  "packageManager": "pnpm@8.15.5+sha256.4b4efa12490e5055d59b9b9fc9438b7d581a6b7af3b5675eb5c5f447cee1a589"
 }