The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content

Release process

Usage​

1. Setup your GITHUB_TOKEN​

You need a GITHUB_TOKEN in your .env file at the root of the repository. You can generate one from the personal access token page with Repo (Full control of private repositories) scope.

GITHUB_TOKEN=<YOUR-PERSONAL-ACCESS-TOKEN>

Once setup, you can run:

info

See Use CLI release commands for the detailed release commands

apic release

It will create a release PR.

2. Review the release PR.​

You need to review the release PR, in two parts:

  1. version changes
  2. CHANGELOGs

You need approval from a member of the @algolia/api-clients-automation team to release clients.

3. The release process.​

After a full CI run, a release commit will be sent to every repository and spread changes to their next branch.

Each language repository should have their own release process, and should run only when the latest commit starts with chore: release. By doing so, we have a way to just update the repository, for example READMEs, without having to release.

SLA graph​

In order to generate the SLA graphs (available here), we leverage the open-source Node.js tools:

The source of truth data lives in the release config file, under the lts field.

Patch lts package​

The lts package has been patched (with yarn patch lts, see diff in .yarn/patches), if you edit the patch, make sure to run yarn patch-commit -s /path/to/your/patch/folder in order to update the lock.

Generate​

apic release -gg