diff --git a/.github/workflows/audit-dev.yml b/.github/workflows/audit-dev.yml index 43bb00fb..60ea1044 100644 --- a/.github/workflows/audit-dev.yml +++ b/.github/workflows/audit-dev.yml @@ -7,6 +7,7 @@ on: push: branches: - main + - main-v1 schedule: - cron: "0 3 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/audit-release.yml b/.github/workflows/audit-release.yml index b8ca5a94..8f13441e 100644 --- a/.github/workflows/audit-release.yml +++ b/.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 diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 6c04f2c6..c5cd65cc 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -4,6 +4,7 @@ on: push: branches: - main + - main-v1 permissions: read-all diff --git a/.github/workflows/config-codecov.yml b/.github/workflows/config-codecov.yml index b1157951..9ab3fe9d 100644 --- a/.github/workflows/config-codecov.yml +++ b/.github/workflows/config-codecov.yml @@ -7,6 +7,7 @@ on: push: branches: - main + - main-v1 paths: - .github/workflows/config-codecov.yml - .github/codecov.yml diff --git a/.github/workflows/config-npm.yml b/.github/workflows/config-npm.yml index af2b3991..fc6f4870 100644 --- a/.github/workflows/config-npm.yml +++ b/.github/workflows/config-npm.yml @@ -7,6 +7,7 @@ on: push: branches: - main + - main-v1 paths: - .github/workflows/config-npm.yml - package.json diff --git a/.github/workflows/fuzz-bash.yml b/.github/workflows/fuzz-bash.yml index 6e804350..f714e072 100644 --- a/.github/workflows/fuzz-bash.yml +++ b/.github/workflows/fuzz-bash.yml @@ -14,6 +14,7 @@ on: - test/fuzz/** branches: - main + - main-v1 schedule: - cron: "0 2 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/fuzz-cmd.yml b/.github/workflows/fuzz-cmd.yml index 86076f42..a16865f3 100644 --- a/.github/workflows/fuzz-cmd.yml +++ b/.github/workflows/fuzz-cmd.yml @@ -14,6 +14,7 @@ on: - test/fuzz/** branches: - main + - main-v1 schedule: - cron: "5 2 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/fuzz-csh.yml b/.github/workflows/fuzz-csh.yml index f5ce9a4c..3d395e0f 100644 --- a/.github/workflows/fuzz-csh.yml +++ b/.github/workflows/fuzz-csh.yml @@ -14,6 +14,7 @@ on: - test/fuzz/** branches: - main + - main-v1 schedule: - cron: "10 2 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/fuzz-dash.yml b/.github/workflows/fuzz-dash.yml index 03820155..189cbe4d 100644 --- a/.github/workflows/fuzz-dash.yml +++ b/.github/workflows/fuzz-dash.yml @@ -14,6 +14,7 @@ on: - test/fuzz/** branches: - main + - main-v1 schedule: - cron: "15 2 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/fuzz-no-shell.yml b/.github/workflows/fuzz-no-shell.yml index 7c3676c0..1af90eee 100644 --- a/.github/workflows/fuzz-no-shell.yml +++ b/.github/workflows/fuzz-no-shell.yml @@ -16,6 +16,7 @@ on: - test/fuzz/** branches: - main + - main-v1 schedule: - cron: "25 2 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/fuzz-powershell.yml b/.github/workflows/fuzz-powershell.yml index 0fcd657c..009fb342 100644 --- a/.github/workflows/fuzz-powershell.yml +++ b/.github/workflows/fuzz-powershell.yml @@ -14,6 +14,7 @@ on: - test/fuzz/** branches: - main + - main-v1 schedule: - cron: "20 2 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/fuzz-zsh.yml b/.github/workflows/fuzz-zsh.yml index aca12d4f..9f462802 100644 --- a/.github/workflows/fuzz-zsh.yml +++ b/.github/workflows/fuzz-zsh.yml @@ -14,6 +14,7 @@ on: - test/fuzz/** branches: - main + - main-v1 schedule: - cron: "30 2 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 3f1cfddb..9464bdd1 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,6 +3,7 @@ on: push: branches: - main + - main-v1 permissions: read-all diff --git a/.github/workflows/secrets.yml b/.github/workflows/secrets.yml index 688dbeb0..3c304ccd 100644 --- a/.github/workflows/secrets.yml +++ b/.github/workflows/secrets.yml @@ -4,6 +4,7 @@ on: push: branches: - main + - main-v1 schedule: - cron: "0 3 * * *" workflow_dispatch: ~ diff --git a/.github/workflows/semgrep.yml b/.github/workflows/semgrep.yml index 6e69a93c..f549890b 100644 --- a/.github/workflows/semgrep.yml +++ b/.github/workflows/semgrep.yml @@ -3,6 +3,7 @@ on: push: branches: - main + - main-v1 permissions: read-all diff --git a/CHANGELOG.md b/CHANGELOG.md index e65f8a5e..07feaa49 100644 --- a/CHANGELOG.md +++ b/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]) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a4af33a..4fd64032 100644 --- a/CONTRIBUTING.md +++ b/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/ diff --git a/SECURITY.md b/SECURITY.md index 1ac39bdd..8e12bcd1 100644 --- a/SECURITY.md +++ b/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 diff --git a/index.js b/index.js index 62d82508..5694ee66 100644 --- a/index.js +++ b/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 */ diff --git a/package-lock.json b/package-lock.json index c9d63be3..f0ee2c6a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "shescape", - "version": "1.7.4", + "version": "2.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "shescape", - "version": "1.7.4", + "version": "2.0.0", "license": "MPL-2.0", "dependencies": { "which": "^3.0.0" diff --git a/package.json b/package.json index 587d655d..6e4b57fd 100644 --- a/package.json +++ b/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", diff --git a/script/release/bump-changelog.js b/script/release/bump-changelog.js index 56dfdb23..8d63dcfe 100644 --- a/script/release/bump-changelog.js +++ b/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_";