Skip to content

Commit

Permalink
RC-926 - Add version bump script (#474)
Browse files Browse the repository at this point in the history
* add script to bump versions

* npm audit fix webpack
  • Loading branch information
zachwreed authored Nov 27, 2023
1 parent 95d4f51 commit 62cfcba
Show file tree
Hide file tree
Showing 7 changed files with 8,066 additions and 11,458 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@ imported into Postman so that you can get started on making requests to Lob API.

## How to bump version

For a MAJOR breaking change on the api, you should bump the first number i.e. `1.xx.xx` -> `2.xx.xx`. For a MINOR change, you should bump the second set of numbers `1.13.x` -> `1.14.0`. For a PATCH change (You are changing a typo or something that doesn't affect logic) you should bump the final set of numbers i.e. `x.xx.10` -> `x.xx.11`.
When bumping the version there are three key areas where the version should be bumped. The first is `package.json`, the second is the `package-lock.json`, and the final, is `lob-api-public.yml`. These all have a property called `version` that should be bumped based on the criteria above.
Run `npm run bump-version <<newversion> | major | minor | patch>`

When bumping the version there are three key areas where the `version` should be bumped. Verify that these versions are updated after running the script
1. `package.json`
2. `package-lock.json`
3. `lob-api-public.yml`

The final step is to ensure you run `npm run bundle && npm run pretty && npm run redoc` to actually appply these changes.
2 changes: 1 addition & 1 deletion dist/lob-api-bundled.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: Lob
version: 1.19.21
version: 1.19.22
description: >
The Lob API is organized around REST. Our API is designed to have
predictable, resource-oriented URLs and uses HTTP response codes to indicate
Expand Down
28 changes: 14 additions & 14 deletions docs/index.html

Large diffs are not rendered by default.

187 changes: 19 additions & 168 deletions lob-api-public.yml

Large diffs are not rendered by default.

Loading

0 comments on commit 62cfcba

Please sign in to comment.