https://github.com/ruizeng/gross

gross is a auto cross compile framework, which using docker to build firmwares.
https://github.com/ruizeng/gross

Last synced: 4 days ago
JSON representation

gross is a auto cross compile framework, which using docker to build firmwares.

• Host: GitHub
• URL: https://github.com/ruizeng/gross
• Owner: ruizeng
• License: mit
• Created: 2015-06-04T16:39:11.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-07-10T06:39:51.000Z (almost 10 years ago)
• Last Synced: 2025-03-30T10:33:47.527Z (about 1 month ago)
• Language: Go
• Size: 254 KB
• Stars: 15
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gross  [![Build Status](https://drone.io/github.com/PandoCloud/gross/status.png)](https://drone.io/github.com/PandoCloud/gross/latest) [![Circle CI](https://circleci.com/gh/PandoCloud/gross/tree/master.svg?style=svg)](https://circleci.com/gh/PandoCloud/gross/tree/master) [![Build Status](https://travis-ci.org/PandoCloud/gross.svg)](https://travis-ci.org/PandoCloud/gross)

gross is an auto cross compiling framework, which uses docker to build firmwares.

### purpose

Building cross compile toolchain for embeded development has always been annoying in traditional ways(may even cause days of efforts). And sometimes we found it hard to make the building progress automatic. We need a more flexible and unmanned firmware delivery pattern. 

### general ideas

So we create gross, with mechanism like below:

1. Use docker to hold firmware cross compile toolchain/sdk. This is a more lightweight aproach than the traditional virtual machine, and can invoke synchronized and isolated build tasks at a time.

2. Integrated into popular git based CVS platforms like github/gitlab. So the building and distributing process can be trigered automatically by source pushing or tagging.

3. The docker builds' output target bin can be discovered by gross. We use file watcher to detect folder changes, get the bin files, and notify the distributing process to handle the built firmware. 

### workflow overview

![](doc/arch.png)

### container convention

1. A gross.sh/gross.bat script MUST exist in the root folder of project source code, which reads a bunch of params from command line. Gross will spawn the script in container with configured params.

2. Make sure the build image has access right to the CVS repo source(You may need to configure a deploy key in the project source).

3. The build container SHOULD expose a shared folder to the gross host. Gross will watch the folder for built target.

4. Typical build script workflow is like below:

	1. clone the repo from cvs

	2. read params from command line

	3. invoke a build command with params specified(eg. "make foo=xx bar=xx")

	4. if build success, copy the target binary to shared folder

	

### usage

TODO