Merge pull request #254 from SergeAstapov/patch-2

Author: Robert Jackson

.github/workflows/nodejs.yml

@@ -22,6 +22,10 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         yarn-version: 1.22.4
+    - name: Install pnpm
+      uses: pnpm/[email protected]
+      with:
+        version: 6.32.3
     - run: yarn install --frozen-lockfile
     - run: yarn lint:js
     - run: yarn test

__tests__/bin-test.js

@@ -471,14 +471,18 @@ describe('main binary', function () {
   });
 
   describe('RELEASE.md', function () {
-    function expectedReleaseContents(isYarn) {
+    function expectedReleaseContents(packageManager = 'npm') {
       let releaseContents = fs.readFileSync(path.join(__dirname, '..', 'release-template.md'), {
         encoding: 'utf8',
       });
 
-      let dependencyInstallReplacementValue = isYarn ? 'yarn install' : 'npm install';
+      let dependencyInstallReplacementValue = `${packageManager} install`;
+      let releaseCommandReplacementValue =
+        packageManager === 'pnpm' ? 'pnpm exec release-it' : 'npx release-it';
 
-      return releaseContents.replace('{{INSTALL_DEPENDENCIES}}', dependencyInstallReplacementValue);
+      return releaseContents
+        .replace('{{INSTALL_DEPENDENCIES}}', dependencyInstallReplacementValue)
+        .replace('{{RELEASE_COMMAND}}', releaseCommandReplacementValue);
     }
 
     it('adds RELEASE.md to repo when no yarn.lock exists', async function () {
@@ -487,7 +491,7 @@ describe('main binary', function () {
       await exec(['--no-install', '--no-label-updates']);
 
       expect(fs.readFileSync('RELEASE.md', { encoding: 'utf8' })).toBe(
-        expectedReleaseContents(false)
+        expectedReleaseContents('npm')
       );
     });
 
@@ -499,7 +503,19 @@ describe('main binary', function () {
       await exec(['--no-install', '--no-label-updates']);
 
       expect(fs.readFileSync('RELEASE.md', { encoding: 'utf8' })).toBe(
-        expectedReleaseContents(true)
+        expectedReleaseContents('yarn')
+      );
+    });
+
+    it('adds RELEASE.md to repo when pnpm-lock.yaml exists', async function () {
+      fs.writeFileSync('pnpm-lock.yaml', '', { encoding: 'utf-8' });
+
+      expect(fs.existsSync('RELEASE.md')).toBeFalsy();
+
+      await exec(['--no-install', '--no-label-updates']);
+
+      expect(fs.readFileSync('RELEASE.md', { encoding: 'utf8' })).toBe(
+        expectedReleaseContents('pnpm')
       );
     });
 
@@ -515,7 +531,18 @@ describe('main binary', function () {
         await exec(['--no-install', '--no-label-updates', '--update']);
 
         expect(fs.readFileSync('RELEASE.md', { encoding: 'utf8' })).toBe(
-          expectedReleaseContents(true)
+          expectedReleaseContents('yarn')
+        );
+      });
+
+      it('updates RELEASE.md when pnpm-lock.yaml exists', async function () {
+        fs.writeFileSync('pnpm-lock.yaml', '', { encoding: 'utf-8' });
+        fs.writeFileSync('RELEASE.md', 'lololol', 'utf8');
+
+        await exec(['--no-install', '--no-label-updates', '--update']);
+
+        expect(fs.readFileSync('RELEASE.md', { encoding: 'utf8' })).toBe(
+          expectedReleaseContents('pnpm')
         );
       });
 
@@ -525,7 +552,7 @@ describe('main binary', function () {
         await exec(['--no-install', '--no-label-updates', '--update']);
 
         expect(fs.readFileSync('RELEASE.md', { encoding: 'utf8' })).toBe(
-          expectedReleaseContents(false)
+          expectedReleaseContents('npm')
         );
       });
 

bin/rwjblue-release-it-setup.js

@@ -212,13 +212,19 @@ function isYarn() {
   return fs.existsSync('yarn.lock');
 }
 
+function isPnpm() {
+  return fs.existsSync('pnpm-lock.yaml');
+}
+
 async function installDependencies() {
   if (labelsOnly || skipInstall) {
     return;
   }
 
   if (isYarn()) {
     await execa('yarn');
+  } else if (isPnpm()) {
+    await execa('pnpm', ['install']);
   } else {
     await execa('npm', ['install']);
   }
@@ -258,11 +264,17 @@ async function main() {
         encoding: 'utf8',
       });
 
-      let dependencyInstallReplacementValue = isYarn() ? 'yarn install' : 'npm install';
+      let dependencyInstallReplacementValue = `${
+        isYarn() ? 'yarn' : isPnpm() ? 'pnpm' : 'npm'
+      } install`;
+
+      let releaseCommandReplacementValue = isPnpm() ? 'pnpm exec release-it' : 'npx release-it';
 
       fs.writeFileSync(
         'RELEASE.md',
-        releaseContents.replace('{{INSTALL_DEPENDENCIES}}', dependencyInstallReplacementValue),
+        releaseContents
+          .replace('{{INSTALL_DEPENDENCIES}}', dependencyInstallReplacementValue)
+          .replace('{{RELEASE_COMMAND}}', releaseCommandReplacementValue),
         { encoding: 'utf8' }
       );
     }

release-template.md

@@ -50,7 +50,7 @@ Once the prep work is completed, the actual release is straight forward:
 * And last (but not least 😁) do your release.
 
 ```sh
-npx release-it
+{{RELEASE_COMMAND}}
 ```
 
 [release-it](https://github.com/release-it/release-it/) manages the actual