Asking for Help

Please run a dusty dump, save the results to a gist, and include a link to the gist in any bug reports.

Running Tests

Unit tests are pretty simple:

$ nosetests tests/unit

Integration tests are also provided which test against an actual running Dusty daemon. A script is provided to help run these inside the tests folder.

WARNING: Integration tests may alter or delete existing Dusty information on your system, including but not limited to your config, Dusty-managed repos, active containers, and Docker VM.

$ ./tests/ # run all tests
$ ./tests/ cli/ # run specific modules inside tests/integration

Building Docs

Docs are built with MkDocs. For development, you can run the following in the root Dusty directory:

$ pip install mkdocs
$ mkdocs serve

Maintaining the Changelog

User-facing changes should be documented in the Changelog as they are merged. Changes are segmented into one of three types:

  • Breaking: Changes to the existing Dusty CLI, specs, or runtime environment which are not backwards-compatible
  • New: A new user-facing feature, or something that enables a workflow that wasn't possible before.
  • Misc: Anything else! Typically bug fixes or notable changes to implementation details.

Release Checklist

  • Update the changelog

    • Add a date to the changelog for this version
    • Add a new version with (In Progress) after it
  • Update Installation to point to the binary for your new version

  • Cut a new release by running the DustyRelease Jenkins job with your new version number

  • Bump the version number in dusty/ to the new, in-progress version

  • Go update the release on GitHub to include the new version's notes from the changelog

  • Follow Homebrew's instructions to update our cask