🥼🧬🧪🔬🧫🦠- Continuously tests Prisma Client with various operating systems, frameworks, platforms, databases and more.
This repository continuously tests Prisma Client on and with various operating systems, databases, frameworks, platforms and other setups.
CI Status | Branch |
---|---|
dev |
|
latest |
|
patch-dev |
|
integration |
|
- |
You can check out the latest test runs by checking the "test" workflow results.
The tests are defined in .github/workflows/test.yaml
and .github/workflows/optional-test.yaml
, and the test projects live in folder of form foo/bar
in this repository. Each foo
has one or multiple jobs in the GitHub Actions Workflows, and the bar
s are part of the matrix per job.
.github/scripts/test-project.sh
, which then executes the test project.prepare.sh
.run.sh
. This includes installing dependencies, deploying etc.test.sh
.finally.sh
which is executed in all cases, even when the tests fail.Note: You need to use pnpm
as it's used for bumping dependencies; i.e. run pnpm install
as a first step in your run.sh
script.
Note: It's important to add prisma
as a devDependency
and @prisma/client
as a normal dependency
in each project's package.json
.
Most tests use a database. The GitHub workflow creates and provides a DATABASE_URL
to all jobs, and .github/scripts/test-project.sh
runs prisma db push
to make sure the project's schema exists on the database.
Projects that use an external database use a different environment variable name from DATABASE_URL
.
Renovate is enabled for this repository for all dependencies except prisma
and @prisma/client
. Our own script handles upgrading prisma-related dependencies since Renovate is too slow for our use case.
When there is a new version, Prismo works tirelessly to commit and push a bump commit, triggering the tests. This is implemented in .github/workflows/check-for-update.yaml
using a GitHub Action cron job. Since the cron job is limited to run each 5 minutes, we just run each cron job for exactly 5 minutes and check for updates each 10 seconds in each run. This check only runs in the default branch dev
.
The default dev
branch of this repository contains the test projects with the development version of Prisma CLI and Prisma Client (@dev
on npm). These dependencies are kept up to date with a GitHub Action workflow, which updates them every time a new version of Prisma is released.
There are also the branches latest
, patch-dev
and integration
, which mirror the code from dev
(synced via a GitHub Action workflow), but they use the respective development channels of Prisma CLI and Prisma Client from npm instead (@latest
, @patch-dev
and @integration
, also updated via a GitHub Action workflow). Thanks to the test coverage of all projects, this can point us to incompatibilities early.
To check the current status of this repository somewhere else, you can use a simple shell script.
We use conventional commits (also known as semantic commits) to ensure consistent and descriptive commit messages.
We develop directly against GitHub Actions. The workflow looks like this:
.github/workflows/test.yaml
under the category the project falls into. For example, if you're adding a new platform into the platforms
folder, put a new line named after your project folder in .github/workflows/test.yaml
under jobs.platforms.strategy.matrix.platform
.Please write POSIX-compliant scripts (not bash) and use the the following template for all of your sh files to make sure they exit on errors (-e
) and undefined variables (-u
):
#!/bin/sh
set -eux
# ...