This documentation is currently incomplete, but feel free to contribute!
Tools
gbuild
At the root of this repository you'll find the gbuild.sh script. This wraps some useful functions for building and testing (currently primitively) GAZE code, Docker Images, documentation, etc.
As always, usage can be seen using the --help
argument:
usage: gbuild [-h] {build,test,push,all} ...
GAZE build tool.
positional arguments:
{build,test,push,all}
build build the gazectl Docker Image and documentation
test test gazectl functionality
push push the gazectl Docker Image, documentation and code
all do all of the above in that order
optional arguments:
-h, --help show this help message and exit
Steps
The development process currently goes something like this:
- Fork this repository.
- Make your changes.
- Use the
gbuild
tool (see above) tobuild
andtest
your changes locally. - Open a Pull Request.
- Our Travis CI pipeline will build and test everything.
- If successful, your changes will be merged.
Support
If you'd like a hand with anything, there are a couple of support channels available: