Skip to content

Commit

Permalink
Update the read me with how to properly release a version (#463)
Browse files Browse the repository at this point in the history
* Update the read me with how to properly release a version

* typo fixes
  • Loading branch information
BennyKitchell authored Sep 6, 2023
1 parent 8fdab97 commit d9914a5
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 28 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# ![CI](https://github.com/lob/lob-openapi/workflows/CI/badge.svg) ![CD](https://github.com/lob/lob-openapi/workflows/CD/badge.svg) Lob [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) Specification

- [What is this project?](#what-is-this-project)
- [Contributing](#contributing)
- [Design](#design)
- [OpenAPI Style Guide and linting](#openapi-style-guide-and-linting)
- [Readability](#readability)
- [OAS v3.1 compatibility](#oas-v31-compatibility)
- [Previewing changes](#previewing-changes)
- [E2E Testing](#e2e-testing)
- [Bundled spec](#bundled-spec)
- [Postman Collection](#postman-collection)
- [ Lob OpenAPI v3 Specification](#--lob-openapi-v3-specification)
- [What is this project?](#what-is-this-project)
- [Contributing](#contributing)
- [Design](#design)
- [OpenAPI Style Guide and linting](#openapi-style-guide-and-linting)
- [Readability](#readability)
- [OAS v3.1 compatibility](#oas-v31-compatibility)
- [Previewing changes](#previewing-changes)
- [Contributing to this repo](#contributing-to-this-repo)
- [E2E Testing](#e2e-testing)
- [Bundled spec](#bundled-spec)
- [Postman Collection](#postman-collection)
- [How to bump version](#how-to-bump-version)

## What is this project?

Expand Down Expand Up @@ -125,3 +128,9 @@ You can generate a big JSON representing a Postman Collection for this spec
locally with `npm run postman`. The resulting `dist/lob-api-postman.json` can be
imported into Postman so that you can get started on making requests to Lob API.
[Here](https://www.youtube.com/watch?v=JDrxdzqghuQ)'s a video tutorial on that.

## 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.
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.13
version: 1.19.17
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
Loading

0 comments on commit d9914a5

Please sign in to comment.