Skip to content

Commit

Permalink
GC-3471 part 2 - Finish bumping version and update documentation so n…
Browse files Browse the repository at this point in the history
…o one else does this (#514)

* GC-3471 correct PCLS cancellation examples

* bundle

* bump lob-api-public.yml version

* update documentation
  • Loading branch information
mike-r-morgan authored Nov 15, 2024
1 parent 3442d49 commit b08e5a5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,4 +138,9 @@ When bumping the version there are three key areas where the `version` should be
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.
Ensure you run `npm run bundle && npm run pretty && npm run redoc` to actually appply changes to package and package-lock. You will need to change lob-api-public.yml manually.

## Deployment
The last step is to [create a new release](https://github.com/lob/lob-openapi/releases/new). Create a new tag to match the version you're deploying and provide a brief description. You can monitor the deployment at the [Deploy to Netlify Action](https://github.com/lob/lob-openapi/actions/workflows/deploy.yml).

[Video Tutorial](https://www.notion.so/lob/Deploying-Lob-OpenAPI-Docs-28f349ae90b4498a8b862881db6a834e)
2 changes: 1 addition & 1 deletion lob-api-public.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: Lob
version: 1.20.2
version: 1.20.3
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 any API errors. <p>
license:
Expand Down

0 comments on commit b08e5a5

Please sign in to comment.