Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (45 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 2.21 KB

Needed tools

  • npm
  • nvm
  • GNU Make

Build process overview

Here is a quick overview of what happen when calling make gen:

  1. cleanup existing files
  2. download Outscale API description (OpenAPI format) (in /osc-api)
  3. call openapi-generator in order to generate typescript-based SDK (in /src)
  4. call typescipt compiler to build .js and .d.ts declaration files (in /dist)

Hacking Outscale SDK

SDK itself is generated from Outscale's OpenAPI description using OpenAPI Genetator.

Other contributions like examples and tests are welcome!

Versioning

This SDK follows semantic versioning from the SDK perspective (not API). Some events may trigger a major (breaking) version of the SDK:

  1. OpenAPI generator introduce a new major version
  2. Outscale introduce a new major version of its API

When OpenAPI generator introduce a breaking change, SDK can be generated in several versions (see corresponding branches)

Generate SDK

  1. have some tools ready: GNU make, git, docker
  2. edit api_version file and to the latest Outscale API version
  3. edit sdk_version file and change it according to semantic versioning
  4. launch sdk generation by running make gen
  5. new sdk is now generated

Under the hood:

  • we get official Outscale yaml
  • run openapi-generator through docker to build osc folder

Sending a Merge Request

Content in src folder is generated at each release. If you plan to make some change here, consider making a pull request in openapi-generator project.

Otherwise:

  • your merge request must be rebased on the corresponding major version branch.
  • be sure that tests still pass by running make test

How to release

  1. fetch outscale and be sure to be on main branch
  2. update api_version to the last Outscale API version
  3. update sdk_version following semantic versioning logic.
  4. make gen to re-build the sdk
  5. make test and fix any issue
  6. commit changes
  7. tag version
  8. push to corresponding branch
  9. create github release

Note that CI should automatically detect new release on osc-api, update the SDK and push a new version.