From 1e205fdc8464a3b4ad571f8cdd20406443f0c831 Mon Sep 17 00:00:00 2001 From: Eric Cornelissen Date: Thu, 7 Dec 2023 23:36:26 +0100 Subject: [PATCH] End v1 support (#1323) Update code base in accordance with the end of life of the v1 release line. Also fix the release guidelines to use a v2 example. --- .github/workflows/audit-dev.yml | 1 - .github/workflows/audit-release.yml | 32 --------------------------- .github/workflows/checks.yml | 1 - .github/workflows/config-codecov.yml | 1 - .github/workflows/config-npm.yml | 1 - .github/workflows/fuzz-bash.yml | 1 - .github/workflows/fuzz-cmd.yml | 1 - .github/workflows/fuzz-csh.yml | 1 - .github/workflows/fuzz-dash.yml | 1 - .github/workflows/fuzz-no-shell.yml | 1 - .github/workflows/fuzz-powershell.yml | 1 - .github/workflows/fuzz-zsh.yml | 1 - .github/workflows/publish.yml | 1 - .github/workflows/secrets.yml | 1 - .github/workflows/semgrep.yml | 1 - CONTRIBUTING.md | 4 ---- RELEASE.md | 22 +++++++++--------- 17 files changed, 11 insertions(+), 61 deletions(-) diff --git a/.github/workflows/audit-dev.yml b/.github/workflows/audit-dev.yml index 5fc1afefc..ee9cbc209 100644 --- a/.github/workflows/audit-dev.yml +++ b/.github/workflows/audit-dev.yml @@ -8,7 +8,6 @@ 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 ebeab2799..2301777cf 100644 --- a/.github/workflows/audit-release.yml +++ b/.github/workflows/audit-release.yml @@ -7,38 +7,6 @@ on: permissions: read-all jobs: - v1: - name: v1 - runs-on: ubuntu-22.04 - steps: - - name: Harden runner - uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.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@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: v1 - - name: Install Node.js - uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0 - with: - cache: npm - node-version-file: .nvmrc - - name: Install dependencies - run: npm clean-install - - name: Audit production npm dependencies - run: npm run audit:runtime v2: name: v2 runs-on: ubuntu-22.04 diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 2d1ec4c9d..c6160b16e 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -4,7 +4,6 @@ on: push: branches: - main - - main-v1 permissions: read-all diff --git a/.github/workflows/config-codecov.yml b/.github/workflows/config-codecov.yml index 47a1a0671..748eca555 100644 --- a/.github/workflows/config-codecov.yml +++ b/.github/workflows/config-codecov.yml @@ -7,7 +7,6 @@ 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 f0aecf000..13e685678 100644 --- a/.github/workflows/config-npm.yml +++ b/.github/workflows/config-npm.yml @@ -7,7 +7,6 @@ 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 f714e072e..6e8043504 100644 --- a/.github/workflows/fuzz-bash.yml +++ b/.github/workflows/fuzz-bash.yml @@ -14,7 +14,6 @@ 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 a16865f31..86076f427 100644 --- a/.github/workflows/fuzz-cmd.yml +++ b/.github/workflows/fuzz-cmd.yml @@ -14,7 +14,6 @@ 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 3d395e0f2..f5ce9a4cf 100644 --- a/.github/workflows/fuzz-csh.yml +++ b/.github/workflows/fuzz-csh.yml @@ -14,7 +14,6 @@ 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 189cbe4de..03820155d 100644 --- a/.github/workflows/fuzz-dash.yml +++ b/.github/workflows/fuzz-dash.yml @@ -14,7 +14,6 @@ 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 1af90eee4..7c3676c03 100644 --- a/.github/workflows/fuzz-no-shell.yml +++ b/.github/workflows/fuzz-no-shell.yml @@ -16,7 +16,6 @@ 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 009fb3425..0fcd657c8 100644 --- a/.github/workflows/fuzz-powershell.yml +++ b/.github/workflows/fuzz-powershell.yml @@ -14,7 +14,6 @@ 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 9f4628025..aca12d4f7 100644 --- a/.github/workflows/fuzz-zsh.yml +++ b/.github/workflows/fuzz-zsh.yml @@ -14,7 +14,6 @@ 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 39019159f..7c90f604b 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,7 +3,6 @@ on: push: branches: - main - - main-v1 permissions: read-all diff --git a/.github/workflows/secrets.yml b/.github/workflows/secrets.yml index 2c2184df0..007652e05 100644 --- a/.github/workflows/secrets.yml +++ b/.github/workflows/secrets.yml @@ -4,7 +4,6 @@ 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 d5b2ec207..3d2e933ce 100644 --- a/.github/workflows/semgrep.yml +++ b/.github/workflows/semgrep.yml @@ -3,7 +3,6 @@ on: push: branches: - main - - main-v1 permissions: read-all diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 902de739a..95ff6893c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,9 +28,6 @@ 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 @@ -612,7 +609,6 @@ 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/RELEASE.md b/RELEASE.md index d160b21bb..df2494e87 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -21,7 +21,7 @@ To release a new version follow these steps: If it's not possible to use automated releases, or if something goes wrong with the automatic release process, you can follow these steps to release a new -version (using `v1.6.2` as an example): +version (using `v2.7.2` as an example): 1. Make sure that your local copy of the repository is up-to-date, sync: @@ -39,15 +39,15 @@ version (using `v1.6.2` as an example): 1. Update the version number in the package manifest and lockfile: ```shell - npm version --no-git-tag-version v1.6.2 + npm version --no-git-tag-version v2.7.2 ``` If that fails, change the value of the version field in `package.json` to the new version: ```diff - - "version": "1.6.1", - + "version": "1.6.2", + - "version": "2.7.1", + + "version": "2.7.2", ``` and update the version number in `package-lock.json` using `npm install` @@ -64,8 +64,8 @@ version (using `v1.6.2` as an example): ```diff * @module shescape - - * @version 1.6.1 - + * @version 1.6.2 + - * @version 2.7.1 + + * @version 2.7.2 * @license MPL-2.0 ``` @@ -81,7 +81,7 @@ version (using `v1.6.2` as an example): ```markdown - _No changes yet_ - ## [1.6.2] - YYYY-MM-DD + ## [2.7.2] - YYYY-MM-DD ``` The date should follow the year-month-day format where single-digit months @@ -115,20 +115,20 @@ version (using `v1.6.2` as an example): 1. Create a [git tag] for the new version: ```shell - git tag v1.6.2 + git tag v2.7.2 ``` 1. Update the major version branch to point to the same commit as the new tag: ```shell - git checkout v1 + git checkout v2 git merge main ``` 1. Push the branch and tag: ```shell - git push origin v1 v1.6.2 + git push origin v2 v2.7.2 ``` 1. Publish to [npm]: @@ -137,7 +137,7 @@ version (using `v1.6.2` as an example): npm publish ``` -1. Create a [GitHub Release]. The release title should be "Release v1.6.2" and +1. Create a [GitHub Release]. The release title should be "Release v2.7.2" and the release text should be the list of changes for the version from the changelog (including links).