Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Client version 0.2.0 — Breaking changes summary #8

Open
krzkaczor opened this issue Jul 6, 2019 · 1 comment
Open

Client version 0.2.0 — Breaking changes summary #8

krzkaczor opened this issue Jul 6, 2019 · 1 comment

Comments

@krzkaczor
Copy link
Member

krzkaczor commented Jul 6, 2019

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 (Fail if any check has been failures #22)

@krzkaczor krzkaczor changed the title Client version 0.2.0 Client version 0.2.0 — Breaking changes summary Jul 13, 2019
@timocov
Copy link

timocov commented Aug 15, 2019

rename directory dist to lib in final package

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants