Add dry runs to CI

jablko · jablko · commit a43e58d8ba43 · 2022-06-28T15:18:20.000-07:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -36,6 +36,21 @@ jobs:
       run: yarn lint
     - name: test
       run: yarn test
+  publish-packages-dry-run:
+    needs: build_and_test
+    uses: ./.github/workflows/publish-packages.yml
+    with:
+      dry-run: true
+  publish-registry-dry-run:
+    needs: build_and_test
+    uses: ./.github/workflows/publish-registry.yml
+    with:
+      dry-run: true
+  retag-dry-run:
+    needs: build_and_test
+    uses: ./.github/workflows/retag.yml
+    with:
+      dry-run: true
   publish_alpha:
     name: publish alpha release
     runs-on: ubuntu-latest
diff --git a/.github/workflows/publish-packages.yml b/.github/workflows/publish-packages.yml
@@ -0,0 +1,42 @@
+name: Publish packages
+#description: Find changed @types packages in the DT repo and publish them to npm.
+on:
+  workflow_call:
+    inputs:
+      dry-run:
+        type: boolean
+  workflow_dispatch:
+    inputs:
+      dry-run:
+        type: boolean
+jobs:
+  publish-packages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: yarn
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - name: Parse declarations
+        run: yarn workspace @definitelytyped/publisher parse
+      - uses: actions/cache@v3
+        with:
+          path: packages/utils/cache/
+          key: cache-${{ github.run_id }}
+          restore-keys: cache-
+      - name: Calculate versions
+        run: yarn workspace @definitelytyped/publisher calculate-versions
+      - name: Generate packages
+        run: yarn workspace @definitelytyped/publisher generate
+      - name: Publish packages${{ (inputs || github.event.inputs).dry-run && ' dry run' || '' }}
+        run: yarn workspace @definitelytyped/publisher publish-packages${{ (inputs || github.event.inputs).dry-run && ' --dry' || '' }}
+        env:
+          GH_API_TOKEN: ${{ github.token }}
+          NPM_TOKEN: ${{ secrets.NPM_RETAG_TOKEN }}
+      - if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ github.job }}
+          path: packages/definitions-parser/data/
diff --git a/.github/workflows/publish-registry.yml b/.github/workflows/publish-registry.yml
@@ -1,9 +1,17 @@
 name: Publish registry
+#description: Publish the types-regsitry package to npm (a list of all @types packages in the DT repo).
 on:
   schedule:
     # https://crontab.guru/#0_0_*_*_0
     - cron: 0 0 * * 0
+  workflow_call:
+    inputs:
+      dry-run:
+        type: boolean
   workflow_dispatch:
+    inputs:
+      dry-run:
+        type: boolean
 jobs:
   publish-registry:
     runs-on: ubuntu-latest
@@ -21,11 +29,12 @@ jobs:
           path: packages/utils/cache/
           key: cache-${{ github.run_id }}
           restore-keys: cache-
-      - name: Publish registry
-        run: yarn workspace @definitelytyped/publisher publish-registry
+      - name: Publish registry${{ (inputs || github.event.inputs).dry-run && ' dry run' || '' }}
+        run: yarn workspace @definitelytyped/publisher publish-registry${{ (inputs || github.event.inputs).dry-run && ' --dry' || '' }}
         env:
           NPM_TOKEN: ${{ secrets.NPM_RETAG_TOKEN }}
       - if: always()
         uses: actions/upload-artifact@v3
         with:
+          name: ${{ github.job }}
           path: packages/definitions-parser/data/
diff --git a/.github/workflows/retag.yml b/.github/workflows/retag.yml
@@ -0,0 +1,39 @@
+name: Update npm tags
+#description: Refresh tags on all DT-published packages in the @types scope.
+on:
+  schedule:
+    # https://crontab.guru/#0_0_*_*_0
+    - cron: 0 0 * * 0
+  workflow_call:
+    inputs:
+      dry-run:
+        type: boolean
+  workflow_dispatch:
+    inputs:
+      dry-run:
+        type: boolean
+jobs:
+  retag:
+    if: github.event_name != 'schedule' || github.repository == 'microsoft/DefinitelyTyped-tools'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: yarn
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - uses: actions/cache@v3
+        with:
+          path: packages/utils/cache/
+          key: cache-${{ github.run_id }}
+          restore-keys: cache-
+      - name: Update npm tags${{ (inputs || github.event.inputs).dry-run && ' dry run' || '' }}
+        run: yarn retag${{ (inputs || github.event.inputs).dry-run && ' --dry' || '' }}
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_RETAG_TOKEN }}
+      - if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ github.job }}
+          path: packages/definitions-parser/data/
diff --git a/.github/workflows/update-ts-version-tags.yml b/.github/workflows/update-ts-version-tags.yml
diff --git a/package.json b/package.json
@@ -11,7 +11,7 @@
     "format": "prettier --write 'packages/**/*.ts'",
     "test": "jest",
     "build": "tsc -b .",
-    "retag": "node packages/retag/dist/retag.js"
+    "retag": "node --require source-map-support/register packages/retag/"
   },
   "devDependencies": {
     "@types/jest": "^25.1.3",
diff --git a/packages/publisher/src/generate-packages.ts b/packages/publisher/src/generate-packages.ts
@@ -1,9 +1,10 @@
 import { makeTypesVersionsForPackageJson } from "@definitelytyped/header-parser";
 import { emptyDir, mkdir, mkdirp, readFileSync } from "fs-extra";
 import path = require("path");
+import process from "process";
 import yargs = require("yargs");
 
-import { defaultLocalOptions } from "./lib/common";
+import { defaultLocalOptions, defaultRemoteOptions } from "./lib/common";
 import { outputDirPath, sourceBranch } from "./lib/settings";
 import {
   assertNever,
@@ -42,7 +43,7 @@ if (!module.parent) {
   const tgz = !!yargs.argv.tgz;
   logUncaughtErrors(async () => {
     const log = loggerWithErrors()[0];
-    const dt = await getDefinitelyTyped(defaultLocalOptions, log);
+    const dt = await getDefinitelyTyped(process.env.GITHUB_ACTIONS ? defaultRemoteOptions : defaultLocalOptions, log);
     const allPackages = await AllPackages.read(dt);
     await generatePackages(dt, allPackages, await readChangedPackages(allPackages), tgz);
   });
diff --git a/packages/publisher/src/publish-packages.ts b/packages/publisher/src/publish-packages.ts
@@ -1,7 +1,8 @@
+import process from "process";
 import applicationinsights = require("applicationinsights");
 import * as yargs from "yargs";
 
-import { defaultLocalOptions } from "./lib/common";
+import { defaultLocalOptions, defaultRemoteOptions } from "./lib/common";
 import { publishNotNeededPackage, publishTypingsPackage } from "./lib/package-publisher";
 import { getDefinitelyTyped, AllPackages } from "@definitelytyped/definitions-parser";
 import {
@@ -19,7 +20,10 @@ import { getSecret, Secret } from "./lib/secrets";
 if (!module.parent) {
   const dry = !!yargs.argv.dry;
   logUncaughtErrors(async () => {
-    const dt = await getDefinitelyTyped(defaultLocalOptions, loggerWithErrors()[0]);
+    const dt = await getDefinitelyTyped(
+      process.env.GITHUB_ACTIONS ? defaultRemoteOptions : defaultLocalOptions,
+      loggerWithErrors()[0]
+    );
     await publishPackages(
       await readChangedPackages(await AllPackages.read(dt)),
       dry,
@@ -42,7 +46,7 @@ export default async function publishPackages(
     log("=== Publishing packages ===");
   }
 
-  const client = await NpmPublishClient.create(await getSecret(Secret.NPM_TOKEN), undefined);
+  const client = await NpmPublishClient.create(dry ? "" : await getSecret(Secret.NPM_TOKEN), undefined);
 
   for (const cp of changedPackages.changedTypings) {
     log(`Publishing ${cp.pkg.desc}...`);
diff --git a/packages/retag/package.json b/packages/retag/package.json
@@ -31,9 +31,6 @@
     "@types/yargs": "^15.0.5"
   },
   "main": "dist/index.js",
-  "bin": {
-    "retag": "./dist/retag.js"
-  },
   "publishConfig": {
     "access": "public"
   }
diff --git a/packages/retag/src/index.ts b/packages/retag/src/index.ts
@@ -1,5 +1,3 @@
-#!/usr/bin/env node
-
 import assert = require("assert");
 import yargs from "yargs";
 import process = require("process");
@@ -49,10 +47,14 @@ async function main() {
  */
 async function tag(dry: boolean, nProcesses: number, name?: string) {
   const log = loggerWithErrors()[0];
-  const options = { definitelyTypedPath: "../DefinitelyTyped", progress: true, parseInParallel: true };
+  const options = process.env.GITHUB_ACTIONS
+    ? { definitelyTypedPath: undefined, progress: false, parseInParallel: false }
+    : { definitelyTypedPath: "../DefinitelyTyped", progress: true, parseInParallel: true };
   await parseDefinitions(
     await getDefinitelyTyped(options, log),
-    { nProcesses: nProcesses || os.cpus().length, definitelyTypedPath: "../DefinitelyTyped" },
+    options.parseInParallel
+      ? { nProcesses: nProcesses || os.cpus().length, definitelyTypedPath: "../DefinitelyTyped" }
+      : undefined,
     log
   );
 
