Skip to content

bioboxes/file-validator

Repository files navigation

Validate Biobox File

This repository contains the code for building the validate-biobox-file tool for bioboxes. Documentation is provided in the doc folder.

Development

On a successful commit to master the following actions happen on the continuous integration server:

  • A new binary version is built using pyinstaller.
  • The archive validate-biobox-file.tar.xz is created from the build.
  • This file is pushed to amazon S3 assuming there is not already an existing file with the same version number.
  • A rebuild is triggered of the bioboxes.org repository.
  • The bioboxes.org website builder will fetch the latest version of the documentation in the doc directory and display this on the site.

To contribute changes to this project, fork the repository and create a feature branch. Once you have pushed your git commits to you forked repository, submit a pull request. The following scripts are provided to help with testing, these should all pass for a PR to be accepted:

  • script/test: Runs python unit tests
  • script/feature: Runs cucumber feature tests against the executable in bin/validate-biobox-file.
  • script/build: Builds a compiled version of the executable and then runs the same feature tests against the compiled verson.