clamp-orchestrator / clamp-core

A microservices flow orchestrator and workflow manager.
https://clamp-orchestrator.github.io/clamp-orchestrator/
MIT License
9 stars 4 forks source link

Add documentation on how to execute ci jobs locally using circleci-cli and docker images. #38

Closed priyaaank closed 4 years ago

priyaaank commented 4 years ago

CircleCI has a cli that can be installed on local machines and can be used to run some jobs locally. This provides a nice capability that test jobs can be executed locally before committing. To ensure that contributors are able to successfully install and run the jobs locally before pushing the code for the pull requests, we need to have a documentation page under the contribution section explaining how to test the changes locally before creating a PR.

This is a ticket to add that documentation on the clam-orchestrator website.

priyaaank commented 4 years ago

This has been added to the contribution section of the documentation. The circleci cli allows you to do that and we have structured the config to allow it to run tests locally. https://clamp-orchestrator.github.io/clamp-orchestrator/docs/core-contribution-guide#running-tests-locally