m3o-client-gen

README

m3o-client-gen

A collection of tools we use to generate clients and examples of our M3O services and it consists of:

Generator

To run the code generation, from the repo root issue:

go install

The general flow is that protos get turned to an openapi json and this generator takes both files (JSON and proto) and generates clients and/or examples for the specified target like go, typescript, dart, cli and shell clients.

To generate Go clients localy, clone the micro/services repo and run this command from the root.

m3o-client-gen go

similarly, to generate typescript, dart or shell:

m3o-client-gen ts

m3o-client-gen dart

m3o-client-gen shell

release-note

The purpose of this program is to fetch the latest commit metadata (sha, html_url and message) from the micro/services repo and output a release note that has the following format.

9ae89b Wordle API (#417)

ts-publish-setup

The purpose of this program is to setup/update the necessary files in order to publish m3o-js clients to npm. It travers through the src folder in the m3o/m3o-js repo to build an array of available services then use that to populate the 'files' field in the package.json. It also creates the .npmrc file which includes authToken for authentication purposes with npm. This program will be used mainly by m3o-publish-ts-action.