This repository provides shared GitHub Actions for MongoDB drivers.

Opinionated actions for each driver should go in their own folder.

This repo uses pre-commit for managing linting. pre-commit performs various checks on the files and uses tools that help follow a consistent style within the repo.

To set up pre-commit locally, run:

brew install pre-commit
pre-commit install

To run pre-commit manually, run pre-commit run --all-files.

To run a manual hook like shellcheck manually, run:

pre-commit run --all-files --hook-stage manual shellcheck

To cut a release, run the Release workflow with the desired bump input (patch, minor, or major). Use dry_run: true first to preview the computed version before pushing anything.

A major bump also updates .github/workflows/version.txt automatically. Internal action-to-action references use $/ and don't need updating on a version bump. The example mongodb-labs/drivers-github-tools/...@vX references in README.md and node/release_template.yml document the tag external consumers pin to, so update those manually after a major bump.