Setup repository

info

Make sure to have Docker installed so you don't have to install the tooling for every API clients. Installation guide

Install the dependencies

bash
nvm use && yarn

bash
nvm use && yarn

Mounting the docker image

You can also execute docker commands one by one, see Docker commands

bash
yarn docker:setup

bash
yarn docker:setup

Docker

Build

Image is built from the Dockerfile

bash
yarn docker:build

bash
yarn docker:build

Mount

Mount docker image on api-clients-automation container

bash
yarn docker:mount

bash
yarn docker:mount

Clean

Stops api-clients-automation container and clean the built image

bash
yarn docker:clean

bash
yarn docker:clean

Contribute

Once you've successfully built and mounted the Docker image, you can now play with the repository! Read our guides on:

• How to add a new client
• How to add a new language
• Use CLI specs commands
• Use CLI clients commands
• Use CLI Common Test Suite commands

Troubleshooting

caution

You should run the commands via the Docker container to avoid issues.

Error: The operation couldn't be completed. Unable to locate a Java Runtime.

Java is not located in your PATH, either source the right .bash_profile, .zshrc, etc. file or do the following command in this repository:

bash
echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' > .bash_profile && source .bash_profile

bash
echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' > .bash_profile && source .bash_profile

Running renovate locally

Running renovate on github can be tidious because it only works on the branch main, but you can run it locally with the CLI:

sh
npm install -g renovate
LOG_LEVEL=debug renovate --dry-run --platform local

sh
npm install -g renovate
LOG_LEVEL=debug renovate --dry-run --platform local