Patch Pipelines and Dockerfiles (#1534)

seek-oss · Jun 20, 2024 · 306c3a0 · 306c3a0
1 parent d88e3c5
commit 306c3a0
Show file tree

Hide file tree

Showing 17 changed files with 728 additions and 109 deletions.
diff --git a/.changeset/unlucky-books-grow.md b/.changeset/unlucky-books-grow.md
@@ -0,0 +1,5 @@
+---
+'skuba': minor
+---
+
+lint: Patch installing specific pnpm version via Corepack
diff --git a/src/cli/__snapshots__/format.int.test.ts.snap b/src/cli/__snapshots__/format.int.test.ts.snap
@@ -17,6 +17,8 @@ Patch skipped: Move .npmrc out of the .gitignore managed section - no .gitignore
 
 Patch skipped: Move .npmrc out of the .dockerignore managed section - no .dockerignore file found
 
+Patch skipped: Ensure the pnpm package manager version specified in package.json is used in Dockerfiles - no packageManager declaration in package.json found
+
 skuba update complete.
 
 Refreshed .eslintignore. refresh-config-files
@@ -90,6 +92,8 @@ Patch skipped: Move .npmrc out of the .gitignore managed section - no .gitignore
 
 Patch skipped: Move .npmrc out of the .dockerignore managed section - no .dockerignore file found
 
+Patch skipped: Ensure the pnpm package manager version specified in package.json is used in Dockerfiles - no packageManager declaration in package.json found
+
 skuba update complete.
 
 Refreshed .eslintignore. refresh-config-files
@@ -160,6 +164,8 @@ Patch skipped: Move .npmrc out of the .gitignore managed section - no .gitignore
 
 Patch skipped: Move .npmrc out of the .dockerignore managed section - no .dockerignore file found
 
+Patch skipped: Ensure the pnpm package manager version specified in package.json is used in Dockerfiles - no packageManager declaration in package.json found
+
 skuba update complete.
 
 Refreshed .eslintignore. refresh-config-files
@@ -199,6 +205,8 @@ Patch skipped: Move .npmrc out of the .gitignore managed section - not ignored
 
 Patch skipped: Move .npmrc out of the .dockerignore managed section - no .dockerignore file found
 
+Patch skipped: Ensure the pnpm package manager version specified in package.json is used in Dockerfiles - no packageManager declaration in package.json found
+
 skuba update complete.
 
 Refreshed .eslintignore. refresh-config-files

diff --git a/src/cli/init/index.ts b/src/cli/init/index.ts
@@ -8,6 +8,8 @@ import { createInclusionFilter } from '../../utils/dir';
 import { createExec, ensureCommands } from '../../utils/exec';
 import { createLogger, log } from '../../utils/logging';
 import { showLogoAndVersionInfo } from '../../utils/logo';
+import { getConsumerManifest } from '../../utils/manifest';
+import { detectPackageManager } from '../../utils/packageManager';
 import {
   BASE_TEMPLATE_DIR,
   ensureTemplateConfigDeletion,
@@ -87,8 +89,22 @@ export const init = async (args = process.argv.slice(2)) => {
   log.newline();
   await initialiseRepo(destinationDir, templateData);
 
+  const [manifest, packageManagerConfig] = await Promise.all([
+    getConsumerManifest(),
+    detectPackageManager(),
+  ]);
+
+  if (!manifest) {
+    throw new Error("Repository doesn't contain a package.json file.");
+  }
+
   // Patch in a baseline Renovate preset based on the configured Git owner.
-  await tryPatchRenovateConfig('format', destinationDir);
+  await tryPatchRenovateConfig({
+    mode: 'format',
+    dir: destinationDir,
+    manifest,
+    packageManager: packageManagerConfig,
+  });
 
   const skubaSlug = `skuba@${skubaVersionInfo.local}`;
 

diff --git a/src/cli/lint/internalLints/patchRenovateConfig.test.ts b/src/cli/lint/internalLints/patchRenovateConfig.test.ts
@@ -5,6 +5,7 @@ import memfs, { vol } from 'memfs';
 import * as Git from '../../../api/git';
 
 import { tryPatchRenovateConfig } from './patchRenovateConfig';
+import type { PatchConfig } from './upgrade';
 
 jest.mock('fs-extra', () => memfs);
 
@@ -51,7 +52,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON({ '.git': null, 'renovate.json': JSON });
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -77,7 +80,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON({ 'foo/.git': null, 'foo/renovate.json': JSON });
 
-      await expect(tryPatchRenovateConfig('format', 'foo')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format', dir: 'foo' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -103,7 +108,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON({ '.git': null, '.github/renovate.json5': JSON5 });
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -137,7 +144,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'no config found',
       });
@@ -159,7 +168,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'due to an error',
       });
@@ -181,7 +192,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'no Git root found',
       });
@@ -198,7 +211,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'owner does not map to a SEEK preset',
       });
@@ -218,7 +233,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'owner does not map to a SEEK preset',
       });
@@ -238,7 +255,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -260,7 +279,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'config already has a SEEK preset',
       });
@@ -280,7 +301,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('format')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'format' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'config already has a SEEK preset',
       });
@@ -300,7 +323,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON({ '.git': null, 'renovate.json': JSON });
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -315,7 +340,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON({ 'foo/.git': null, 'foo/renovate.json': JSON });
 
-      await expect(tryPatchRenovateConfig('lint', 'foo')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint', dir: 'foo' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -333,7 +360,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON({ '.git': null, '.github/renovate.json5': JSON5 });
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -354,7 +383,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'no config found',
       });
@@ -371,7 +402,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'no Git root found',
       });
@@ -388,7 +421,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'owner does not map to a SEEK preset',
       });
@@ -408,7 +443,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'owner does not map to a SEEK preset',
       });
@@ -428,7 +465,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'apply',
       });
 
@@ -450,7 +489,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'config already has a SEEK preset',
       });
@@ -470,7 +511,9 @@ describe('patchRenovateConfig', () => {
 
       vol.fromJSON(files);
 
-      await expect(tryPatchRenovateConfig('lint')).resolves.toEqual({
+      await expect(
+        tryPatchRenovateConfig({ mode: 'lint' } as PatchConfig),
+      ).resolves.toEqual({
         result: 'skip',
         reason: 'config already has a SEEK preset',
       });

diff --git a/src/cli/lint/internalLints/patchRenovateConfig.ts b/src/cli/lint/internalLints/patchRenovateConfig.ts
@@ -155,10 +155,10 @@ const patchRenovateConfig = async (
   return { result: 'apply' };
 };
 
-export const tryPatchRenovateConfig = (async (
-  mode: 'format' | 'lint',
+export const tryPatchRenovateConfig = (async ({
+  mode,
   dir = process.cwd(),
-) => {
+}) => {
   try {
     // In a monorepo we may be invoked within a subdirectory, but we are working
     // with Renovate config that should be relative to the repository root.