doc-detective 3.1.0-dev.2 → 3.1.0-dev.3

package/.github/workflows/update-core.yaml

@@ -46,57 +46,31 @@ jobs:
           echo "Failed to install doc-detective-core@${{ steps.version.outputs.version }} or doc-detective-common@${{ steps.common_version.outputs.common_version }}"
           exit 1
         }
-          npm audit fix
     
     - name: Test the installation
       run: |
         npm test
     
-    - name: Commit changes
-      id: commit
+    - name: Stage changes
+      id: stage
       run: |
         git add package.json package-lock.json
         if git diff --staged --quiet; then
           echo "No changes to commit"
           echo "has_changes=false" >> $GITHUB_OUTPUT
         else
-          git commit -m "chore: bump doc-detective-core version to ${{ steps.version.outputs.version }}"
-          git push
           echo "has_changes=true" >> $GITHUB_OUTPUT
         fi
 
     - name: Bump or sync version
       id: patch
-      if: steps.commit.outputs.has_changes == 'true'
+      if: steps.stage.outputs.has_changes == 'true'
       run: |
-        git checkout -- .
-        git clean -fd
-        # Get current project version
-        PROJ_VERSION=$(node -p "require('./package.json').version")
-        # Get doc-detective-core version (strip ^ or ~)
-        CORE_VERSION=$(node -p "(require('./package.json').dependencies['doc-detective-core'] || require('./package.json').devDependencies['doc-detective-core'] || '').replace(/^[^\\d]*/, '')")
-        # Parse versions
-        PROJ_MAJOR=$(echo $PROJ_VERSION | cut -d. -f1)
-        PROJ_MINOR=$(echo $PROJ_VERSION | cut -d. -f2)
-        core_MAJOR=$(echo $CORE_VERSION | cut -d. -f1)
-        core_MINOR=$(echo $CORE_VERSION | cut -d. -f2)
-        if [ "$PROJ_MAJOR" != "$core_MAJOR" ] || [ "$PROJ_MINOR" != "$core_MINOR" ]; then
-          # Major or minor mismatch: set version to match doc-detective-core major.minor.0
-          NEW_VERSION="$core_MAJOR.$core_MINOR.0"
-          npm version --no-git-tag-version "$NEW_VERSION"
-        else
-          # Only patch changed: bump patch
-          npm version patch --no-git-tag-version
-        fi
-        git add package.json package-lock.json
-        git commit -m "bump version to match doc-detective-core"
-        git push
-        git tag "v$(node -p \"require('./package.json').version\")"
-        git push --tags
-        echo "version=$(node -p \"require('./package.json').version\")" >> $GITHUB_OUTPUT
+        node scripts/bump-sync-version-core.js
+        version=$(node -p 'require("./package.json").version') && echo "version=$version" >> $GITHUB_OUTPUT
 
-    - name: Create release
-      if: steps.commit.outputs.has_changes == 'true'
+    - name: Install GitHub CLI
+      if: steps.stage.outputs.has_changes == 'true'
       # Install GitHub CLI for fetching PRs and release notes
       run: |
         sudo apt-get update && sudo apt-get install -y gh jq
@@ -120,9 +94,11 @@ jobs:
           echo "$PRS" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
         fi
+      env:
+        GITHUB_TOKEN: ${{ secrets.DD_DEP_UPDATE_TOKEN }}
 
     - name: Fetch doc-detective-core release notes
-      id: core_release
+      id: CORE_release
       run: |
         CORE_VERSION=${{ steps.version.outputs.version }}
         # Remove ^ or ~ if present
@@ -132,9 +108,11 @@ jobs:
         echo "release_notes<<EOF" >> $GITHUB_OUTPUT
         echo "$RELEASE_INFO" >> $GITHUB_OUTPUT
         echo "EOF" >> $GITHUB_OUTPUT
+      env:
+        GITHUB_TOKEN: ${{ secrets.DD_DEP_UPDATE_TOKEN }}
 
     - name: Create release with detailed notes
-      if: steps.commit.outputs.has_changes == 'true'
+      if: steps.stage.outputs.has_changes == 'true'
       uses: softprops/action-gh-release@v2
       with:
         body: |
@@ -142,7 +120,7 @@ jobs:
 
           - Updated doc-detective-core to v${{ steps.patch.outputs.version }}:
 
-            ${{ steps.core_release.outputs.release_notes }}
+            ${{ steps.CORE_release.outputs.release_notes }}
 
           ${{ steps.merged_prs.outputs.prs }}
         tag_name: "v${{ steps.patch.outputs.version }}"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "3.1.0-dev.2",
+  "version": "3.1.0-dev.3",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -33,8 +33,8 @@
   "homepage": "https://github.com/doc-detective/doc-detective#readme",
   "dependencies": {
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
-    "doc-detective-common": "^3.1.0-dev.1",
-    "doc-detective-core": "^3.1.0-dev.2",
+    "doc-detective-common": "^3.1.0",
+    "doc-detective-core": "^3.1.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

package/scripts/bump-sync-version-core.js

@@ -0,0 +1,110 @@
+#!/usr/bin/env node
+
+const { execSync } = require("child_process");
+const fs = require("fs");
+const path = require("path");
+const semver = require("semver");
+
+function execCommand(command, options = {}) {
+  try {
+    return execSync(command, {
+      encoding: "utf8",
+      stdio: "inherit",
+      ...options,
+    });
+  } catch (error) {
+    console.error(`Error executing command: ${command}`);
+    process.exit(1);
+  }
+}
+
+function main() {
+  // Clean git state
+    execCommand("git checkout -- .");
+    execCommand("git clean -fd");
+
+  // Get current project version
+  const packageJsonPath = path.join(process.cwd(), "package.json");
+
+  if (!fs.existsSync(packageJsonPath)) {
+    console.error("Error: package.json not found");
+    process.exit(1);
+  }
+
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+  const projVersion = semver.minVersion(packageJson.version);
+
+  // Get doc-detective-core version
+  const coreVersion = semver.minVersion(
+    packageJson.dependencies?.["doc-detective-core"] ||
+      packageJson.devDependencies?.["doc-detective-core"] ||
+      ""
+  );
+
+  if (!coreVersion) {
+    console.error("Error: doc-detective-core dependency not found");
+    process.exit(1);
+  }
+
+  if (!semver.valid(projVersion)) {
+    console.error(`Error: Invalid project version format: ${projVersion}`);
+    process.exit(1);
+  }
+
+  // Extract major and minor versions using semver
+  const projMajor = semver.major(projVersion);
+  const projMinor = semver.minor(projVersion);
+  const coreMajor = semver.major(coreVersion);
+  const coreMinor = semver.minor(coreVersion);
+
+  console.log(`Project version: ${projMajor}.${projMinor}.x`);
+  console.log(`core version: ${coreMajor}.${coreMinor}.x`);
+
+  let newVersion;
+
+  if (projMajor !== coreMajor || projMinor !== coreMinor) {
+    // Major or minor mismatch: set version to match doc-detective-core major.minor.0
+    newVersion = `${coreMajor}.${coreMinor}.0`;
+
+    // Validate the new version before setting it
+    if (!semver.valid(newVersion)) {
+      console.error(`Error: Generated invalid version: ${newVersion}`);
+      process.exit(1);
+    }
+
+    console.log(`Version mismatch detected. Setting version to: ${newVersion}`);
+    execCommand(`npm version --no-git-tag-version ${newVersion}`);
+  } else {
+    // Project version is already equal or greater than core version, just bump patch
+    console.log("Project version is current or ahead. Bumping patch version.");
+    execCommand("npm version patch --no-git-tag-version");
+    // Get the new version after bumping
+    const updatedPackageJson = JSON.parse(
+      fs.readFileSync(packageJsonPath, "utf8")
+    );
+    newVersion = updatedPackageJson.version;
+  }
+
+  // Commit changes
+  execCommand("git add package.json package-lock.json");
+  execCommand(
+    'git commit -m "update doc-detective-core [skip ci]"'
+  );
+
+  // Create tag
+  execCommand(`git tag "v${newVersion}"`);
+
+  // Push changes and tags
+  execCommand("git push");
+  execCommand("git push --tags");
+
+  // Output version (equivalent to echo in bash script)
+  console.log(`version=${newVersion}`);
+}
+
+// Run the script
+if (require.main === module) {
+  main();
+}
+
+module.exports = { main };

package/src/utils.js

@@ -117,7 +117,7 @@ async function setConfig({ configPath, args }) {
     config.logLevel = args.logLevel;
   }
   if (typeof args.allowUnsafe === "boolean") {
-    config.allowUnsafeTests = args.allowUnsafe;
+    config.allowUnsafeSteps = args.allowUnsafe;
   }
   // Resolve paths
   config = await resolvePaths({

package/test/utils.test.js

@@ -169,7 +169,7 @@ describe("Util tests", function () {
         ],
         expected: {
           input: [path.resolve(process.cwd(), "input.spec.json")],
-          allowUnsafeTests: true,
+          allowUnsafeSteps: true,
         },
       }
     ];