Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 4.31 KB

README.md

File metadata and controls

117 lines (79 loc) · 4.31 KB
Raw

nci

Flexible, open source continuous integration server written in node.js

It's good for those who prefer modular things to build system for specific requirements by blocks, starting from small core then extend functionality by plugins.

Npm version Build Status Coverage Status Known Vulnerabilities

Features

  • modular approach, small core a lot of plugins (e.g. rest api, web interface - plugins, not core)
  • modest system requirements (only node and scm clients are required, no external db)
  • pluginnable db storage (any levelup backend could be used)
  • using on-the-fly snappy compression for all stored data (builds, build logs) when leveldb (via leveldown backend) is used
  • working with any mercurial, git repositories (no matter is it service like github, bitbucket or private server, all you need is authenticate user from which nci server is running without password e.g. by ssh key)
  • damn fast single page web application interface (classic ui plugin)
  • server and projects could be configured with yaml (yaml reader plugin) - provides pretty shell scripting (strings without quotes, nice multiline strings, etc)
  • provides agile project relations out of the box (see blocks, blockedBy, trigger at sample project config)
  • could catch every or specific commits (see catchRev at sample project config)

System requirements

  • unix-like operating system, not tested on windows
  • node.js >= 0.10
  • git client >= 1.9 (only for building git projects)
  • mercurial client >= 2.8 (only for building mercurial projects)

Quick setup

Clone quick setup repo, go into it and install dependencies.

You can choose from one of following repositories with sample configurations:

  • With local node (all builds will be executed locally from user that started nci server):
git clone https://github.com/node-ci/nci-quick-setup && cd nci-quick-setup && npm install
  • With docker node (all builds will be executed within docker, requires installed docker client and server):
git clone https://github.com/node-ci/nci-docker-node-quick-setup && cd nci-docker-node-quick-setup && npm install

After installing dependencies run nci:

node_modules/.bin/nci

that's all, now you can experiment with it by adding/changing projects, use web interface (on http://127.0.0.1:3000 by default) for run project builds, etc.

Currently web interface doesn't support adding new projects or editing of existing projects. You have to do that by adding/editing project config file.

See basic tutorial for setup and usage details.

Resources

Plugins