Setup repository

info

Make sure to have:

• Docker installed so you don’t have to install the tooling for every API clients
• jq because it’s nice

Install the dependencies

nvm use && yarn

Mounting the docker images

We use multiple docker images to simplify the build. There is one base image that contains everything except swift and ruby, they have their own Dockerfile

yarn docker:setup

Tooling

info

This step is optional, using yarn cli ... should work perfectly as well.

Install the CLI tool by following the instructions at the top of scripts/install.sh to acces apic from your terminal, with bash autocompletion. You can run apic help to check if it’s working properly.

Clean

Stops all containers and clean the images

docker compose down --rmi all

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 release 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:

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:

npm install -g renovate

GITHUB_COM_TOKEN="<github token>" LOG_LEVEL=debug renovate --dry-run --platform local