Skip to content

etcaterva/eas-js-sdk

Repository files navigation

This npm package is published here: echaloasuerte-js-sdk

To publish a new version

We need to release a new version of the SDK everytime something changes in the backend API (i.e when something is changed in the the swagger file).

To publish a new version of the SDK, follow the steps above:

  1. Install openapi-generator if you haven't done it already

    brew install openapi-generator
    
  2. Generate the SDK using the latest version of the swagger file

    // Clone the repo
    git clone git@github.com:etcaterva/eas-js-sdk.git
    
    // Generate the sdk
    cd eas-js-sdk
    make generate-sdk
    
  3. Push the sdk upstream

    git add -A
    git commit -m "Update SDK"
    git push origin master
    
  4. Release the new version

    1. Go to the releases section of this repo
    2. Click on Draft a new release
    3. Fill the tag with the appropriate version
    4. Publish the release! (and wait for the pipeline to finish)

To install the new version in the client

From the client do:

npm i echaloasuerte-js-sdk@latest --save-dev