Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.34 KB

DEVELOPERS.md

File metadata and controls

53 lines (32 loc) · 1.34 KB
Raw

Developing

Welcome to the developers guide for chkdns!

Install dependencies

Install dependencies with poetry:

poetry install

Building

To keep local builds consistent with ci, use make to build and lint:

make build

Install pre commit hooks

The project uses pre-commit for commit time checking. You can find the configuration here.

pre-commit install

Updating the server list

Sometimes the list of servers used by chkdns can become stale resulting in an Invalid server response for certain requests. When this happens it is usually time to update the server list to match what is being used by whatsmydns.net.

Run make scrap_servers to generate a new list then update the SERVERS variable in this file.

Releasing stuff

Releasing is a semi manual but well oiled method. Tags are used to trigger the release steps in the ci process.

Running the following make command will tag and push the latest commit triggering a release.

make tag version="v0.0.5"

Note: Releases can only be generated from the main branch.

Runing locally

You can either build a new package using make build and install it or run the package directly:

poetry run chkdns