Skip to content

development.md

Latest commit

 

History

History
95 lines (61 loc) · 3.32 KB

development.md

File metadata and controls

95 lines (61 loc) · 3.32 KB
Raw

River development

Run tests

Raise the test database:

createdb river_test

Run tests:

make test

By default, this runs all workspace modules and database drivers. Use make test/race to enable the race detector.

To run only the SQLite, libSQL, and Turso driver tests (no PostgreSQL needed):

make test TEST_DATABASE=sqlite

To run the regular suite with the SQLite driver tests excluded:

make test TEST_DATABASE=postgres

TEST_DATABASE also applies to make test/race. CI separates these suites so the PostgreSQL version matrix doesn't repeat the SQLite tests. Each suite still runs on both supported Go versions. Only the latest combination in each matrix uses the race detector, marked race in its job title.

Run lint

Run the linter and try to autofix:

golangci-lint run --fix

Generate sqlc

The project uses sqlc (brew install sqlc) to generate Go targets for Postgres queries. After changing an sqlc .sql file, generate Go with:

make generate

Raise and migrate development database

To run programs locally outside of tests, create and raise a development database:

createdb river_dev
go run ./cmd/river migrate-up --database-url postgres:///river_dev --line main

If needed, override Postgres timeouts for long-running migrations with root CLI flags:

go run ./cmd/river --statement-timeout 2m migrate-up --database-url postgres:///river_dev --line main

Releasing a new version

  1. Fetch changes to the repo and any new tags. Export VERSION by incrementing the last tag. Execute update-mod-version to add it the project's go.mod files:

    git checkout master && git pull --rebase
export VERSION=v0.x.y
make update-mod-version
git checkout -b $USER-$VERSION

  2. Prepare a PR with the changes, updating CHANGELOG.md with any necessary additions at the same time. Include [skip ci] in the commit description so that CI doesn't run and pollute the Go Module cache by trying to fetch a version that's not available yet (and it would fail anyway). Have it reviewed and merged.

  3. Upon merge, pull down the changes, tag each module with the new version, and push the new tags:

    git checkout master && git pull --rebase
git tag cmd/river/$VERSION -m "release cmd/river/$VERSION"
git tag riverdriver/$VERSION -m "release riverdriver/$VERSION"
git tag riverdriver/riverpgxv5/$VERSION -m "release riverdriver/riverpgxv5/$VERSION"
git tag riverdriver/riverdatabasesql/$VERSION -m "release riverdriver/riverdatabasesql/$VERSION"
git tag riverdriver/riversqlite/$VERSION -m "release riverdriver/riversqlite/$VERSION"
git tag rivershared/$VERSION -m "release rivershared/$VERSION"
git tag rivertype/$VERSION -m "release rivertype/$VERSION"
git tag $VERSION

  4. Push new tags to GitHub:

    git push --tags

  5. Cut a new GitHub release by visiting new release, selecting the new tag, and copying in the version's CHANGELOG.md content as the release body.

Updating Go or toolchain versions in all go.mod files

Modify go.work so it contains the new desired version in go and/or toolchain directives, then run make update-mod-go to have it reflect the new version(s) into all the workspace's go.mod files:

make update-mod-go