chore: update our release process

Author: gustavovalverde

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/ten-terms-rescue.md

@@ -0,0 +1,5 @@
+---
+"h2m-parser": minor
+---
+
+Fast HTML to Markdown converter with Mozilla Readability extraction, streaming renderer, and LLM-ready output. 3.75x faster than alternatives

.github/workflows/performance-regression.yml

@@ -14,44 +14,42 @@ permissions:
   contents: read
 
 jobs:
-  performance-check:
+  regression:
+    if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout PR
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5.0.0
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
-          persist-credentials: false
+          persist-credentials: true
 
       - name: Setup Node.js
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 #v5.0.0
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
           node-version: '20'
 
+      - name: Enable Corepack
+        run: corepack enable
+
       - name: Setup pnpm
         uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
         with:
           version: 10.17.1
+          run_install: false
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
       - name: Build project
         run: pnpm build
 
-      - name: Checkout main branch baseline
-        if: github.event_name == 'pull_request'
+      - name: Restore main baseline
         run: |
-          git fetch origin main
+          git fetch origin main --depth=1
           git checkout origin/main -- bench/.baseline/performance-baseline.json || true
-          git checkout -
-
-      - name: Capture baseline (main branch only)
-        if: github.ref == 'refs/heads/main'
-        run: node bench/capture-baseline.js
 
       - name: Check for regressions
-        if: github.event_name == 'pull_request'
         id: regression-check
         run: |
           if node bench/check-regression.js; then
@@ -61,59 +59,58 @@ jobs:
           fi
 
       - name: Upload regression report
-        if: github.event_name == 'pull_request' && always()
+        if: always()
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: regression-report
           path: bench/.results/regression-report.md
+          if-no-files-found: ignore
 
       - name: Comment PR with results
-        if: github.event_name == 'pull_request' && always()
-        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd #v8.0.0
+        if: always()
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
         with:
           script: |
             const fs = require('fs');
             const path = require('path');
+            const reportPath = path.join(process.env.GITHUB_WORKSPACE, 'bench', '.results', 'regression-report.md');
 
-            try {
-              const reportPath = path.join(process.env.GITHUB_WORKSPACE, 'bench', '.results', 'regression-report.md');
-              if (fs.existsSync(reportPath)) {
-                const report = fs.readFileSync(reportPath, 'utf8');
-
-                // Find existing comment
-                const { data: comments } = await github.rest.issues.listComments({
-                  owner: context.repo.owner,
-                  repo: context.repo.repo,
-                  issue_number: context.issue.number,
-                });
-
-                const botComment = comments.find(comment =>
-                  comment.user.type === 'Bot' &&
-                  comment.body.includes('Performance Regression Report')
-                );
-
-                const body = `🤖 **Performance Check Results**\n\n${report}`;
-
-                if (botComment) {
-                  // Update existing comment
-                  await github.rest.issues.updateComment({
-                    owner: context.repo.owner,
-                    repo: context.repo.repo,
-                    comment_id: botComment.id,
-                    body
-                  });
-                } else {
-                  // Create new comment
-                  await github.rest.issues.createComment({
-                    owner: context.repo.owner,
-                    repo: context.repo.repo,
-                    issue_number: context.issue.number,
-                    body
-                  });
-                }
-              }
-            } catch (error) {
-              console.error('Failed to comment on PR:', error);
+            if (!fs.existsSync(reportPath)) {
+              return;
+            }
+
+            const report = fs.readFileSync(reportPath, 'utf8');
+            const body = `🤖 **Performance Check Results**
+
+            ${report}`;
+
+            const response = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+
+            const comments = response.data;
+
+            const botComment = comments.find(comment =>
+              comment.user.type === 'Bot' &&
+              comment.body.includes('Performance Check Results')
+            );
+
+            if (botComment) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: botComment.id,
+                body,
+              });
+            } else {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body,
+              });
             }
 
       - name: Fail if regression detected
@@ -122,8 +119,41 @@ jobs:
           echo "❌ Performance regression detected! See report above."
           exit 1
 
-      - name: Commit baseline updates (main branch only)
-        if: github.ref == 'refs/heads/main'
+  update-baseline:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+          persist-credentials: true
+
+      - name: Setup Node.js
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
+        with:
+          node-version: '20'
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+        with:
+          version: 10.17.1
+          run_install: false
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build project
+        run: pnpm build
+
+      - name: Capture baseline
+        run: node bench/capture-baseline.js
+
+      - name: Commit baseline updates
         run: |
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"

.github/workflows/publish-tag.yml

@@ -17,6 +17,9 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://www.npmjs.com/package/@lgtm/htmltomd
     steps:
       - name: Checkout
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5.0.0
@@ -35,6 +38,7 @@ jobs:
           node-version: 20
           cache: 'pnpm'
           registry-url: 'https://registry.npmjs.org'
+          always-auth: true
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
@@ -57,7 +61,6 @@ jobs:
           createGithubReleases: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN || '' }}  # TODO: remove when OIDC is configured
 
       - name: Publish notification
         if: steps.changesets.outputs.published == 'true'

.github/workflows/release.yml

@@ -2,9 +2,7 @@ node_modules
 .DS_Store
 dist
 coverage
-.results
 .bench
-bench/.results
 bench/output
 fixtures/
 .vscode
@@ -13,9 +11,6 @@ fixtures/
 .env*
 .nyc_output
 
-# Changeset state
-.changeset
-
 # TypeDoc generated documentation
 docs/api
 docs/api-markdown

.gitignore

@@ -21,6 +21,7 @@ Thanks for your interest in improving h2m-parser! Keeping cognitive load low is
 
 - Husky runs `lint-staged` to format/lint staged files. Make sure your commits are clean.
 - Use [Changesets](https://github.com/changesets/changesets) for release notes. After feature work, run `pnpm changeset` to document changes and version bumps.
+- When the release PR opens, review the changelog and, after merging, approve the pending run in the `release` environment to publish.
 - CI runs `pnpm lint`, `pnpm typecheck`, `pnpm test`, and `pnpm build`. Keep the `verify` script green locally before pushing.
 
 ## Reporting issues