Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (65 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

92 lines (65 loc) · 3.68 KB

Development

Prerequisites

  • JDK 11

Commits

Since August 2022 the commit messages follow the Conventional Commits standard. This allows for easier and better release notes generation.

How to submit a patch

  1. Fork this project on GitHub
  2. make some changes
  3. git commit -m 'type: what changes are made to the source'
  4. git push
  5. Create a pull request

⚠️ Do not force push to your PR branch. This makes the reviewer's job more difficult because it clears what changes have already been reviewed or not. The commits will be squashed while merging anyway.

How to compile the native libraries

Prerequisites

  1. JDK 11
  2. Perl
  3. Maven
  4. make
  5. gcc
  6. curl
  7. unzip
  8. Docker (for cross-compilation only)

Version update

  1. Edit the VERSION file and set the SQLite version to use.
  2. Edit the version number in pom.xml to ${VERSION}.0-SNAPSHOT. So if VERSION=3.39.2, the version number in pom.xml should be 3.39.2.0-SNAPSHOT.

Build for the current platform

# For the current platform
$ make native

Build for all platforms

The native library is cross-compiled for different OS and architecture by using Docker.

$ make native-all

On Windows it is recommended to use WSL2.

You can check the native-all goal in Makefile for a list of available targets.

Build with an external amalgamation archive

By default, sqlite-jdbc will download the SQLite amalgamation in order to build the native libraries.

You can use an existing installation of SQLite instead, by passing SQLITE_OBJ=/path/to/libsqlite3.a and SQLITE_HEADER=/path/to/sqlite3.h.

Example:

make native SQLITE_OBJ=/usr/local/lib/libsqlite3.so SQLITE_HEADER=/usr/local/include/sqlite3.h

Build from CI

The native libraries can all be built with Github Actions:

  • by running the Build Native workflow manually
  • by commenting "/native" on a PR

Once the build succeeds, a commit will be added to the branch or PR with the updated binaries.

Release process

The project version can change by 2 means:

  1. By changing the bundled version of SQLite, in which case the project version changes to align with the SQLite version. This is a manual process for now.
  2. When triggering a release. This is done automatically through GitHub Actions.

Trigger a release

A release can be triggered from GitHub Actions by manually running the CI workflow and ticking the Perform release option.

What happens when performing a release?

Multiple actions will happen in sequence, all orchestrated by the GitHub workflow:

  1. The version in pom.xml is changed to remove the -SNAPSHOT. This is done by using the Maven Versions plugin.
  2. Deploy to Maven Central. This is done by using the Maven deploy goal with the release profile. It relies on credentials stored in the repository's secrets.
  3. Perform a release commit with the changed pom.xml, as well as creating a git tag with the version number.
  4. Create a GitHub release. This is done via JReleaser, and will also include a changelog since the last release.
  5. The version in pom.xml is incremented for the next snapshot.
  6. Perform a commit with the version updated for the next snapshot.

Snapshot publishing

The CI workflow will also publish a new snapshot to Sonatype's snapshots repository whenever a change occurs.