bump version to go with changes in RC-898

README.md

@@ -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.

dist/lob-api-bundled.yml

@@ -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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lob/openapi",
-  "version": "1.19.21",
+  "version": "1.19.22",
   "engines": {
     "node": ">=14.16.0",
     "npm": ">=7.9.0"
@@ -54,6 +54,7 @@
     }
   },
   "scripts": {
+    "bump-version": "npm version $1 --no-git-tag-version && npm install && node ./scripts/yml-version-bump.js",
     "build": "webpack --config webpack.config.js",
     "bundle": "openapi bundle -o dist/$npm_package_config_bundlefile $npm_package_config_specfile",
     "clean": "rm -rf dist",
@@ -112,7 +113,8 @@
     "waypoints": "^4.0.1",
     "webpack": "^5.72.1",
     "webpack-cli": "^4.7.2",
-    "webpack-dev-server": "^4.9.0"
+    "webpack-dev-server": "^4.9.0",
+    "yaml": "^2.3.4"
   },
   "dependencies": {
     "@redocly/cli": "^1.0.0-beta.102",

scripts/yml-version-bump.js

@@ -0,0 +1,37 @@
+const fs = require("fs");
+const YAML = require("yaml");
+const { version } = require("../package.json");
+
+/**
+ * @typedef {Object} LobApiPublicYamlInfo
+ * @property {string} version
+ */
+
+/**
+ * @typedef {Object} LobApiPublicYaml
+ * @property {LobApiPublicYamlInfo} info
+ */
+
+const updateLobApiPublicYmlVersion = async () => {
+  try {
+    const file = await fs.promises.readFile("./lob-api-public.yml", "utf8");
+    /** @type LobApiPublicYaml */
+    const lobApiPublic = YAML.parse(file);
+    lobApiPublic.info.version = version;
+    await fs.promises.writeFile(
+      "./lob-api-public.yml",
+      YAML.stringify(lobApiPublic, {
+        minContentWidth: 0,
+        lineWidth: 0,
+      })
+    );
+    console.log(`updated version in lob-api-public.yml to ${version}`);
+  } catch (err) {
+    console.error(
+      `error updating version in lob-api-public.yml to ${version}`,
+      err
+    );
+  }
+};
+
+updateLobApiPublicYmlVersion();