Skip to content

A super class template for custom tasks to be run using gbdx-cloud-harness

License

Notifications You must be signed in to change notification settings

michaelconnor00/gbdx-task-template

Repository files navigation

gbdx-task-template

https://circleci.com/gh/michaelconnor00/gbdx-task-template/tree/master.svg?style=shield

A super class template for custom tasks to be run using gbdx-cloud-harness, see https://github.com/TDG-Platform/cloud-harness.

Development

Contributing

Please contribute! Please make pull requests directly to master. Before making a pull request, please:

  • Ensure that all new functionality is covered by unit tests.
  • Verify that all unit tests are passing.
  • Ensure that all functionality is properly documented.t
  • Ensure that all functions/classes have proper docstrings so sphinx can autogenerate documentation.
  • Fix all versions in setup.py (and requirements.txt)

Run Tests

Tests use pytest framework

py.test [...]
python -m pytest [...]

Create a new version

To create a new version:

bumpversion ( major | minor | patch )
git push --tags

Don't forget to update the changelog

About

A super class template for custom tasks to be run using gbdx-cloud-harness

Resources

License

Stars

Watchers

Forks

Packages

No packages published