Release v2.0.0 (#1181)

.github/workflows/audit-dev.yml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "0 3 * * *"
   workflow_dispatch: ~

.github/workflows/audit-release.yml

@@ -39,3 +39,35 @@ jobs:
         run: npm clean-install
       - name: Audit production npm dependencies
         run: npm run audit:runtime
+  v2:
+    name: v2
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Harden runner
+        uses: step-security/harden-runner@8ca2b8b2ece13480cda6dacd3511b49857a23c09 # v2.5.1
+        with:
+          disable-sudo: true
+          egress-policy: block
+          allowed-endpoints: >
+            actions-results-receiver-production.githubapp.com:443
+            api.github.com:443
+            artifactcache.actions.githubusercontent.com:443
+            ghcr.io:443
+            github.com:443
+            gitlab.com:443
+            nodejs.org:443
+            objects.githubusercontent.com:443
+            registry.npmjs.org:443
+      - name: Checkout repository
+        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        with:
+          ref: v2
+      - name: Install Node.js
+        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        with:
+          cache: npm
+          node-version-file: .nvmrc
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Audit production npm dependencies
+        run: npm run audit:runtime

.github/workflows/checks.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - main-v1
 
 permissions: read-all
 

.github/workflows/config-codecov.yml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - main
+      - main-v1
     paths:
       - .github/workflows/config-codecov.yml
       - .github/codecov.yml

.github/workflows/config-npm.yml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - main
+      - main-v1
     paths:
       - .github/workflows/config-npm.yml
       - package.json

.github/workflows/fuzz-bash.yml

@@ -14,6 +14,7 @@ on:
       - test/fuzz/**
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "0 2 * * *"
   workflow_dispatch: ~

.github/workflows/fuzz-cmd.yml

@@ -14,6 +14,7 @@ on:
       - test/fuzz/**
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "5 2 * * *"
   workflow_dispatch: ~

.github/workflows/fuzz-csh.yml

@@ -14,6 +14,7 @@ on:
       - test/fuzz/**
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "10 2 * * *"
   workflow_dispatch: ~

.github/workflows/fuzz-dash.yml

@@ -14,6 +14,7 @@ on:
       - test/fuzz/**
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "15 2 * * *"
   workflow_dispatch: ~

.github/workflows/fuzz-no-shell.yml

@@ -16,6 +16,7 @@ on:
       - test/fuzz/**
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "25 2 * * *"
   workflow_dispatch: ~

.github/workflows/fuzz-powershell.yml

@@ -14,6 +14,7 @@ on:
       - test/fuzz/**
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "20 2 * * *"
   workflow_dispatch: ~

.github/workflows/fuzz-zsh.yml

@@ -14,6 +14,7 @@ on:
       - test/fuzz/**
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "30 2 * * *"
   workflow_dispatch: ~

.github/workflows/publish.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - main
+      - main-v1
 
 permissions: read-all
 

.github/workflows/secrets.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - main-v1
   schedule:
     - cron: "0 3 * * *"
   workflow_dispatch: ~

.github/workflows/semgrep.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - main
+      - main-v1
 
 permissions: read-all
 

CHANGELOG.md

@@ -7,6 +7,10 @@ Versioning].
 
 ## [Unreleased]
 
+- _No changes yet_
+
+## [2.0.0] - 2023-09-07
+
 - BREAKING CHANGE: Change main API from an object to a class. ([#963])
 - BREAKING CHANGE: Drop support for Node.js `^10.13.0`, `^12`, `14.0.0` through
   `14.18.0`, and `16.0.0` through `16.13.0`. ([#963])

CONTRIBUTING.md

@@ -26,6 +26,9 @@ relevant sections of this document.
   - [Package Documentation](#package-documentation)
   - [Code Documentation](#code-documentation)
 
+> **Note** If you want to make a contribution to v1 of the project, please refer
+> to the [Contributing Guidelines for v1].
+
 ---
 
 ## Reporting Issues
@@ -588,6 +591,7 @@ const john = "John Doe";
 [actionlint]: https://github.com/rhysd/actionlint
 [ava]: https://github.com/avajs/ava
 [cc by-sa 4.0]: https://creativecommons.org/licenses/by-sa/4.0/
+[contributing guidelines for v1]: https://github.com/ericcornelissen/shescape/blob/main-v1/CONTRIBUTING.md
 [bug report]: https://github.com/ericcornelissen/shescape/issues/new?labels=bug&template=bug_report.md
 [editorconfig]: https://editorconfig.org/
 [eslint]: https://eslint.org/

SECURITY.md

@@ -12,10 +12,11 @@ with security updates.
 
 | Version | End-of-life |
 | ------: | :---------- |
-|   1.x.x | -           |
+|   2.x.x | -           |
+|   1.x.x | 2023-12-06  |
 |   0.x.x | 2021-02-01  |
 
-_This table only includes information on versions `<2.0.0`._
+_This table only includes information on versions `<3.0.0`._
 
 ## Reporting a Vulnerability
 

index.js

@@ -4,7 +4,7 @@
  *
  * @overview Entrypoint for the library.
  * @module shescape
- * @version 1.7.4
+ * @version 2.0.0
  * @license MPL-2.0
  */
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shescape",
-  "version": "1.7.4",
+  "version": "2.0.0",
   "description": "simple shell escape library",
   "homepage": "https://github.com/ericcornelissen/shescape#readme",
   "license": "MPL-2.0",

script/release/bump-changelog.js

@@ -7,6 +7,8 @@
 import fs from "node:fs";
 import path from "node:path";
 
+import { common } from "../_.js";
+
 const STR_UNRELEASED = "## [Unreleased]";
 const STR_NO_CHANGES = "- _No changes yet_";