Skip to content

Commit

Permalink
End v1 support (#1323)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ericcornelissen authored Dec 7, 2023
1 parent a426207 commit 1e205fd
Show file tree
Hide file tree
Showing 17 changed files with 11 additions and 61 deletions.
1 change: 0 additions & 1 deletion .github/workflows/audit-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ on:
push:
branches:
- main
- main-v1
schedule:
- cron: "0 3 * * *"
workflow_dispatch: ~
Expand Down
32 changes: 0 additions & 32 deletions .github/workflows/audit-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- main
- main-v1

permissions: read-all

Expand Down
1 change: 0 additions & 1 deletion .github/workflows/config-codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
push:
branches:
- main
- main-v1
paths:
- .github/workflows/config-codecov.yml
- .github/codecov.yml
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/config-npm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
push:
branches:
- main
- main-v1
paths:
- .github/workflows/config-npm.yml
- package.json
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/fuzz-bash.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
- test/fuzz/**
branches:
- main
- main-v1
schedule:
- cron: "0 2 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/fuzz-cmd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
- test/fuzz/**
branches:
- main
- main-v1
schedule:
- cron: "5 2 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/fuzz-csh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
- test/fuzz/**
branches:
- main
- main-v1
schedule:
- cron: "10 2 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/fuzz-dash.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
- test/fuzz/**
branches:
- main
- main-v1
schedule:
- cron: "15 2 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/fuzz-no-shell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ on:
- test/fuzz/**
branches:
- main
- main-v1
schedule:
- cron: "25 2 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/fuzz-powershell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
- test/fuzz/**
branches:
- main
- main-v1
schedule:
- cron: "20 2 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/fuzz-zsh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
- test/fuzz/**
branches:
- main
- main-v1
schedule:
- cron: "30 2 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ on:
push:
branches:
- main
- main-v1

permissions: read-all

Expand Down
1 change: 0 additions & 1 deletion .github/workflows/secrets.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- main
- main-v1
schedule:
- cron: "0 3 * * *"
workflow_dispatch: ~
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/semgrep.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ on:
push:
branches:
- main
- main-v1

permissions: read-all

Expand Down
4 changes: 0 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/
Expand Down
22 changes: 11 additions & 11 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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`
Expand All @@ -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
```

Expand All @@ -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
Expand Down Expand Up @@ -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]:
Expand All @@ -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).

Expand Down

0 comments on commit 1e205fd

Please sign in to comment.