How Tos

How to update dependencies?

Variant 1: Do it manually

yarn dependencies

Use yarn upgrade-interactively and update the dependency or a list of dependencies. Run all checks (e.g. via yarn check:all) and fix errors which occur. In case of updates in the major version have a look at the changelog of the dependency where breaking changes are defined. Don't forget to run yarn dedupe after your updates (deduplicates dependencies with overlapping ranges, see https://yarnpkg.com/cli/dedupe).

It is recommended to make smaller commits / PRs with only some updates instead of always updating everything. Merge the PRs into main when some updates succeed and do not break the CI.

Rust

Variant 2: Set up and use dependa-bot

See https://docs.github.com/en/code-security/dependabot/working-with-dependabot, set it up in the repository and merge the PRs. In case the CI breaks, fix the error in the particular pull request.

How to update the version of Node.JS / Rust / Python

We manage asdf for our tool chain. Here you can also update the used programming language. Example with Node.JS:

# List all versions of Node.JS
asdf list all nodejs

# Install version X
asdf install nodejs X

In case the repository has a .tool-versions file make sure that you change it accordingly (e.g. via asdf local nodejs X). After installing the new version make sure that you make the appropriate changes in the repository:

• Update GitHub actions (for example https://github.com/serlo/cloudflare-worker/blob/47fc44af9841fb67c5c42696aa30fd74e0865c7a/.github/workflows/js.yml#L11 need to have the right version)
• Update Dockerfile for all created docker files (example https://github.com/serlo/api.serlo.org/blob/56aff08b8c5d3d66602c53190d47ac1544d76b2b/packages/server/docker/server/Dockerfile#L1)
• For Node.JS: Update engines in package.json (see https://github.com/serlo/cloudflare-worker/blob/47fc44af9841fb67c5c42696aa30fd74e0865c7a/package.json#L83-L85)
• Make sure everything is still working (tests, lints, build of docker images, ...)

How to update yarn?

See https://yarnpkg.com/cli/set/version