monorepo icon indicating copy to clipboard operation
monorepo copied to clipboard

Client version 0.2.0 — Breaking changes summary

Open krzkaczor opened this issue 6 years ago • 1 comments

Proposed breaking changes:

  • do not implicitly initialize client but rather make it explicit like:
const client = new CodechecksClient();

instead of

import { client } from "@codechecks/client";

This will result in multiple benefits like a possibility to provide defaults for a check, client can execute checks in parallel etc.

  • rename directory dist to lib in final package

  • isFork should be a boolean in execution ctx

  • rename saveValue/getValue to saveJSON/getJSON

  • support scope setting. Useful for monorepos with multiple codechecks files. All codechecks artifacts and titles would share some scope

  • by default, it exit with non-zero exit code if any report failed as discussed (https://github.com/codechecks/monorepo/issues/22)

krzkaczor avatar Jul 06 '19 22:07 krzkaczor

rename directory dist to lib in final package

I hope you'll remove __tests__ folder from the package as well :)

timocov avatar Aug 15 '19 08:08 timocov