https://github.com/rioki/autobuild

Continous integration on the developer PC.
https://github.com/rioki/autobuild

Last synced: 5 days ago
JSON representation

Continous integration on the developer PC.

Host: GitHub
URL: https://github.com/rioki/autobuild
Owner: rioki
Created: 2012-10-11T12:30:05.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2026-05-22T10:47:45.000Z (17 days ago)
Last Synced: 2026-05-22T16:54:41.522Z (16 days ago)
Language: JavaScript
Size: 248 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Autobuild
=========

Autbuild is continous integration on the developer PC.

The main idea behind autobuild is, instead of hitting build, check and deploy
in your IDE or command line, autobuild will to that for you. You change a file
everything gets built, checked and deployed. What build, check and deploy means
is up to you, you specify it in a JSON file.

Examples
--------

The following example shows the autobuild definition for a make file oriented
project.

The optional `configure` step runs once on startup before file watching begins.

autobuild.json:

{
"name": "My Project",
"sources": {
"directories": [
"./include",
"./src",
"./src/extra",
],
"patterns": [".cpp", ".h"]
},
"build": {
"cwd": "./build",
"command": "make"
},
"configure": {
"cwd": "./build",
"command": "cmake .."
},
"check": {
"cwd": "./build",
"command": "make check"
},
"deploy": {
"cwd": "./build",
"command": "make install"
},
"run": {
"cwd": "./build",
"command": "./my_app"
}
}

The following example shows the autobuild definition for a Visual C++ 6 project.

autobuild.json:

{
"name": "Custom Requirements Assesment Program",
"sources": {
"directories": [
"y:\\CRAP_SRC\\_inc",
"y:\\CRAP_SRC\\crap",
"y:\\CRAP_SRC\\utils",
],
"patterns": [".cpp", ".cc", ".h", ".hpp"],
},
"build": {
"cwd": "y:\\CRAP_SRC\\_equ",
"command": "msdev.exe crap.dsw /MAKE \\"ALL - RELEASE\\""
},
"deploy": {
"source": "y:\\CRAP_DO\\win23\\release",
"target": "C:\\Program Files\\Crap",
"files": [
"crap.exe",
"crap.pdb",
"utils.dll",
"utils.pdb"
]
}
}

Installation
------------

Autobuild requires Node.js 18 or newer.

The easiest way to install it is with npm:

npm install -g autobuild

Usage
-----

Invoke it as a command line utility

autobuild autobuild.json

Autobuild always runs with a terminal UI (TUI). The top row shows
the pipeline state (`configure -> build -> check -> deploy -> run`) using gray (idle),
blue (running), green (success), and red (failed). The lower pane shows the
output of the currently running or last finished task.

If a `run` step is configured, press Ctrl+R to trigger it manually.

License
-------

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/rioki/autobuild

Awesome Lists containing this project

README