node-ci / nci Goto Github PK

View Code? Open in Web Editor NEW

129.0 16.0 26.0 1.42 MB

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

License: Other

JavaScript 100.00%

nodejs ci mercurial git docker leveldb embedded-database

nci's Introduction

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.

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

nci's People

Contributors

Stargazers

Watchers

nci's Issues

[Suggestion] Use NodeGit for Git SCM

I think the git scm could use NodeGit, this would make the code clearer and remove all git command output parsing

Missing data.io dependency

After running git clone https://github.com/node-ci/nci-quick-setup && cd nci-quick-setup && npm install
and node_modules/.bin/nci I get the following error:

/nci-quick-setup/node_modules/nci/app.js:255
        if (err) throw err;
                 ^

Error: Cannot find module './node_modules/data.io/lib/server'
    at Function.Module._resolveFilename (module.js:339:15)
    at Function.Module._load (module.js:290:25)
    at Module.require (module.js:367:17)
    at require (internal/module.js:16:19)
    at Object.<anonymous> (/home/orehov/Downloads/nci-quick-setup/node_modules/nci-classic-ui/dataio.js:4:11)
    at Module._compile (module.js:413:34)
    at Object.Module._extensions..js (module.js:422:10)
    at Module.load (module.js:357:32)
    at Function.Module._load (module.js:314:12)
    at Module.require (module.js:367:17)

Running npm install data.io fixes the problem.

[Suggestion] Update code style to ES6

Thanks for this awesome CI Server. I want to contribute to it because I want to use it for one of my projects.
I suggest to update and refactor code to ES6 style. It's more clear and more robust. (This could be done with lebab )
I think it would be better to provide also a Promise-based API (Using async/await ?) (we could conserve a compatibility with callback api) this could make the code base more clear by removing the usage of twostep

[Bug] Cancel build in "get sources" step

One day the build process hung in step "get sources" on command "git fetch". But I could not cancel it:

Fri, 07 Sep 2018 10:27:27 GMT] [resources error handler] Error is occurred during requesting /builds cancel: Error: Can`t cancel build: no current cmd
    at Group.self.canceled (/home/dmitry/WebstormProjects/nci-app/node_modules/nci/lib/executor/base.js:279:11)
    at Group.<anonymous> (/home/dmitry/WebstormProjects/nci-app/node_modules/twostep/lib/twoStep.js:171:15)
    at next (/home/dmitry/WebstormProjects/nci-app/node_modules/twostep/lib/twoStep.js:159:9)
    at iterateSteps (/home/dmitry/WebstormProjects/nci-app/node_modules/twostep/lib/twoStep.js:164:7)
    at /home/dmitry/WebstormProjects/nci-app/node_modules/twostep/lib/twoStep.js:129:3
    at /home/dmitry/WebstormProjects/nci-app/node_modules/twostep/lib/twoStep.js:187:32
    at Executor.cancel (/home/dmitry/WebstormProjects/nci-app/node_modules/nci/lib/executor/base.js:275:2)
    at Group.<anonymous> (/home/dmitry/WebstormProjects/nci-app/node_modules/nci/lib/distributor.js:504:14)
    at Group.<anonymous> (/home/dmitry/WebstormProjects/nci-app/node_modules/twostep/lib/twoStep.js:171:15)
    at next (/home/dmitry/WebstormProjects/nci-app/node_modules/twostep/lib/twoStep.js:159:9)

NCI cancel method works with self.currentCmd which declared only in project configuration steps

Limit the changes list on the first build

It is more of a suggestion. Maybe it would be better to limit the changes list to maybe last 100 commits. I am building the Linux kernel using nci and just retrieving the changes list takes like several minutes. left alone that amount of information on the screen becomes unmanageable. I would suggest having some kind of a "Show more" button which will then load all of the log messages.

"Show more builds" button disappears

It happens when I have two opened pages: "main" builds page and some project page. When I initiate a new build from the project page, "Show more builds" button disappears on the main builds page.

Can't figure out how to use this...

Hey there,

I am very excited by the idea of a CI server written in Node.js and would love to contribute if that would be of any use? Only thing is, I have no idea how I am supposed to use it?

Any pointers to get started firing it up?

Cheers,

James

Builds without scm

Hi, I'd love to have ability to run scripts without scm since I do scm management in my scripts and I only need nci as a runner. Is it possible to do so?

When `withScmChangesOnly` flag is not set doesn't update repo

I think this flag should only skip build if there are no changes. But it looks like if the withScmChangesOnly is false, nci doesn't even update the repo to find out whether the latter has any changes.

In particular, I have a problem with git webhook, where I can't set withScmChangesOnly flag at all (it's always false). So it always rebuilds old version when webhook is triggered (builds from scheduler are okay, though)

should ignore files like .DS_Store in data/projects

/Users/xream/Project/xream/nci-boilerplate/node_modules/.1.0.8@nci/app.js:8
        if (err) throw err;
                 ^

Error: ENOTDIR: not a directory, scandir '/Users/xream/Project/xream/nci-boilerplate/data/projects/.DS_Store'

Integration with GitHub or Bitbucket

Hi. I'm curious, if there is a simple way to catch GitHub's webhook and run build? As I see, your REST API is expecting valid project field, which is missing in the webhook payload. Any suggestions are welcome.

Notify X when build failed or succeeded (hooks)

As in the title, is it possible to have success and failure notifications integrated with third party services? I am specifically interested in Slack integration.