Skip to content

Commit

Permalink
rel: prep release v4.1.0 (#391)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?

- new release v4.1.0

## Short description of the changes

- update release doc for clarity and consistency
- bump version to 4.1.0
- update changelog
  • Loading branch information
JamieDanielson authored Aug 18, 2023
1 parent 355e4ee commit b43b445
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 12 deletions.
37 changes: 37 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
# libhoney-js changelog

## [4.1.0] - 2023-08-17

### Fixes

- fix: replace superagent-proxy with direct use of proxy-agent (#389) | [@robbkidd](https://github.com/robbkidd)
- Note: This resolves a security vulnerability in transitive dependency vm2 (CVE-2023-37466)

### Maintenance

- maint: extra test to check for http info from proxy (#390) | [@JamieDanielson](https://github.com/JamieDanielson)
- docs: add development.md (#374) | [@vreynolds](https://github.com/vreynolds)
- maint: add smoke test (#383) | [@vreynolds](https://github.com/vreynolds)
- maint(deps-dev): bump eslint from 8.24.0 to 8.46.0 (#387)
- maint(deps-dev): bump @rollup/plugin-commonjs from 25.0.2 to 25.0.3 (#385)
- maint(deps-dev): bump @babel/preset-env from 7.22.5 to 7.22.9 (#386)
- maint(deps-dev): bump babel-jest from 29.5.0 to 29.6.2 (#384)
- maint(deps-dev): bump prettier from 2.8.7 to 3.0.0 (#388)
- maint(deps-dev): bump @babel/core from 7.20.12 to 7.22.9 (#382)
- maint(deps-dev): bump @rollup/plugin-node-resolve from 15.0.1 to 15.1.0 (#376)
- maint(deps-dev): bump @rollup/plugin-commonjs from 24.0.1 to 25.0.2 (#377)
- maint(deps-dev): bump @babel/preset-env from 7.21.4 to 7.22.5 (#378)
- maint(deps): bump word-wrap from 1.2.3 to 1.2.4 (#381)
- maint(deps): bump superagent from 8.0.2 to 8.0.9 (#365)
- maint(deps): bump semver from 6.3.0 to 6.3.1 (#379)
- maint(deps-dev): bump @babel/eslint-parser from 7.19.1 to 7.21.8 (#370)
- maint(deps): bump vm2 from 3.9.17 to 3.9.18 (#369)
- maint(deps-dev): bump jest from 29.1.2 to 29.5.0 (#366)
- maint(deps-dev): bump rollup from 2.79.0 to 3.20.2 (#358)
- maint(deps-dev): bump @babel/preset-env from 7.19.3 to 7.21.4 (#357)
- maint(deps): bump vm2 from 3.9.16 to 3.9.17 (#361)
- maint(deps-dev): bump prettier from 2.7.1 to 2.8.7 (#355)
- maint(deps-dev): bump babel-jest from 29.3.1 to 29.5.0 (#356)
- maint(deps-dev): bump @rollup/plugin-commonjs from 24.0.0 to 24.0.1 (#348)
- maint(deps): bump vm2 from 3.9.15 to 3.9.16 (#360)
- maint(deps): bump vm2 from 3.9.11 to 3.9.15 (#359)
- maint(deps): bump cookiejar from 2.1.3 to 2.1.4 (#345)

## [4.0.1] - 2023-01-19

### Fixes
Expand Down
25 changes: 18 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# Release Process

1. Add release entry to [changelog](./CHANGELOG.md)
2. Update version using `npm version --no-git-tag-version patch` (replace patch with minor / major as needed)
3. Open a PR with the above, and merge that into main
4. Create new tag on merged commit with the new version (e.g. `git tag -a v2.3.1 -m "v2.3.1"`)
5. Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v2.3.1`
6. Copy change log entry for newest version into draft GitHub release created as part of CI publish steps
- generate release notes via github release draft for full changelog notes and any new contributors
- Use `npm version --no-git-tag-version` to update the version number using `major`, `minor`, `patch`, or the prerelease variants `premajor`, `preminor`, or `prepatch`.
For example, to bump from v1.1.1 to the next patch version:

```shell
> npm version --no-git-tag-version patch # 1.1.1 -> 1.1.2
```

- Confirm the version number update appears in `package.json` and `package-lock.json`.
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two:
- `git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log`
- `git log --pretty='%C(green)%d%Creset- %s | [%an](https://github.com/)'`
- Commit changes, push, and open a release preparation pull request for review.
- Once the pull request is merged, fetch the updated `main` branch.
- Apply a tag for the new version on the merged commit (e.g. `git tag -a v2.3.1 -m "v2.3.1"`)
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v2.3.1`
- Ensure that there is a draft GitHub release created as part of CI publish steps (this will also publish to NPM).
- Click "generate release notes" in GitHub for full changelog notes and any new contributors
- Publish the GitHub draft release
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "libhoney",
"version": "4.0.1",
"version": "4.1.0",
"description": " Honeycomb.io Javascript library",
"bugs": "https://github.com/honeycombio/libhoney-js/issues",
"repository": {
Expand Down Expand Up @@ -54,12 +54,13 @@
"superagent": "^8.0.0",
"url-join": "^5.0.0"
},

"jest": {
"setupFilesAfterEnv": [
"./setupTests.js"
],
"transformIgnorePatterns": ["/node_modules/(?!url-join)"],
"transformIgnorePatterns": [
"/node_modules/(?!url-join)"
],
"testPathIgnorePatterns": [
"dist/",
"/node_modules/"
Expand Down

0 comments on commit b43b445

Please sign in to comment.