optimizely / eleneor-fern-generator

Optimizely's Fern API which is used to generate SDKs.

Optimizely API

Tagging a release on this repository will update the following clients

• Browser Typescript SDK
• Python SDK
• Go SDK
• Java SDK

What is in this repository?

This repository contains

• Eleanor's OpenAPI spec which lives in the openapi folder
• Generators (see generators.yml)

To make sure that the OpenAPI is valid, you can use the Fern CLI.

npm install -g fern-api
fern check

What are generators?

Generators read in your API Definition and output artifacts (e.g. python-sdk, java-sdk, typescript-browser-sdk, go-sdk) and are tracked in generators.yml.

To trigger the generators run:

fern generate

fern generate --group publish --version <version>

The publish command currently runs in a GitHub workflow (see ci.yml). To trigger the generators using Github Actions:

1. Click on Releases

2. Click on Draft a new release

3. Click on Choose a tag

4. Specify a version

This version string is used when publishing SDKs to registries (e.g. npm, maven).

5. In the title, re-enter the version number

6. Click on Publish release

7. Click on Actions

See the Actions that will run fern generate.

---