CONTRIBUTING.md

Contributing

If you would like to contribute to the DPK CLI Runtime, you're very welcome to open a GitHub pull request (PR).

Prerequisites

The make targets will install most needed tools at the appropriate version as-needed. They are installed via asdf directory and referenced there so as to avoid interfering with any tools you might already have installed. If you wish to pre-install these tools, a convenience make target can be used: make install-tools.

NOTE: On MacOS, please use current GNU Coreutils, installed via homebrew (see here for details, especially the instructions to correctly configure your PATH to include the gnubin directory) and GNU Findutils, installed via homebrew (see here for details).

Installing pre-commit hook

This project comes with a pre-commit configuration and it is highly recommended to install the respective git hook:

make install-tool.pre-commit
pre-commit install
pre-commit install -t commit-msg

Running Make targets in a Docker container

You can run any of the Make targets of this project inside of a Docker container using the ci.docker.run target:

make ci.docker.run RUN_WHAT="make build-snapshot"

To run an interactive bash shell in the Docker container used in CI, run:

make ci.docker.run

Upgrading tools

To upgrade all tools used in the repo, run:

make upgrade-tools

Publishing a new release

Create and push a Git tag to publish a new release. This will start the Release workflow which will create the GitHub release.