npmci/README.md

91 lines
4.4 KiB
Markdown
Raw Normal View History

2016-05-30 01:40:07 +00:00
# NPMCI
2016-06-03 22:35:43 +00:00
npmci is your friend when it comes to handling npm packages during CI builds. It is optimized for GitLab CI
2016-05-30 08:57:08 +00:00
## Availabililty
2017-02-08 20:32:22 +00:00
[![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmci)
[![git](https://gitzone.gitlab.io/assets/repo-button-git.svg)](https://gitlab.com/gitzone/npmci)
[![git](https://gitzone.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/gitzone/npmci)
[![docs](https://gitzone.gitlab.io/assets/repo-button-docs.svg)](https://gitzone.gitlab.io/npmci/docs)
## Status for master
2017-02-08 20:32:22 +00:00
[![build status](https://gitlab.com/gitzone/npmci/badges/master/build.svg)](https://gitlab.com/gitzone/npmci/commits/master)
[![coverage report](https://gitlab.com/gitzone/npmci/badges/master/coverage.svg)](https://gitlab.com/gitzone/npmci/commits/master)
[![Dependency Status](https://david-dm.org/gitzonetools/npmci.svg)](https://david-dm.org/gitzonetools/npmci)
[![bitHound Dependencies](https://www.bithound.io/github/gitzonetools/npmci/badges/dependencies.svg)](https://www.bithound.io/github/gitzonetools/npmci/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/gitzonetools/npmci/badges/code.svg)](https://www.bithound.io/github/gitzonetools/npmci)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
2016-05-30 08:57:08 +00:00
## Usage
npmci is designed to work in docker CI environments. The following docker images come with npmci presinstalled:
Docker Hub:
2016-05-30 09:05:28 +00:00
2016-06-08 21:18:02 +00:00
* [hosttoday/ht-docker-node:npmci](https://hub.docker.com/r/hosttoday/ht-docker-node/)
has LTS node version and npmci preinstalled.
2016-06-03 22:59:17 +00:00
* [hosttoday/ht-docker-dbase](https://hub.docker.com/r/hosttoday/ht-docker-dbase/)
2016-06-08 21:18:02 +00:00
based on docker:git, can be used to build docker images in conjunction with docker:dind
2016-05-30 08:57:08 +00:00
npmci can be called from commandline:
```shell
# Install any node version:
npmci install lts # will install latest LTS node version and update PATH for node and npm versions
2016-06-03 22:35:43 +00:00
npmci install stable # will install latest stable node version and update PATH for node and npm
npmci install legacy # will install latest legacy node version and update PATH for node and npm
2016-05-30 08:57:08 +00:00
npmci install x.x.x # will install any specific node version.
# Install any node version, install dependencies and run test in cwd:
2016-05-30 09:08:21 +00:00
npmci test lts # will install latest lts node version and run "npm install" and "npm test".
2016-06-03 22:35:43 +00:00
npmci test stable # will install latest stable node version and run "npm install" and "npm test".
npmci test legacy # will install latest legacy node version and run "npm install" and "npm test".
npmci test x.x.x # will install any specific node version and run "npm install" and "npm test".
2016-06-03 22:41:25 +00:00
npmci test docker # will test any build image with tests defined in ./npmci/dockertest_1.sh to ./npmci/dockertest_100.sh
2016-06-08 21:18:02 +00:00
## npmci test docker will look at all Dockerfiles and look for according tags on GitLab container registry
2016-06-03 22:35:43 +00:00
# prepare tools
2016-06-03 22:41:25 +00:00
npmci prepare npm # will look for $NPMCI_TOKEN_NPM env var and create .npmrc, so npm is authenticated
npmci prepare docker # will look for $NPMCI_LOGIN_DOCKER in form username|password and authenticate docker
npmci prepare docker-gitlab # will authenticate docker for gitlab container registry
2016-06-03 22:35:43 +00:00
# build containers
2016-06-08 21:18:02 +00:00
npmci build docker # will build containers
2016-12-11 15:33:56 +00:00
## all Dockerfiles named Dockerfile* are picked up.
## specify tags like this Dockerfile_[tag]
2016-06-08 21:18:02 +00:00
## uploads all built images as [username]/[reponame]:[tag]_test to GitLab
## then test in next step with "npmci test docker"
2016-05-30 08:57:08 +00:00
# publish npm module
2016-06-03 22:35:43 +00:00
npmci publish npm # will look vor $NPMCI_TOKEN_NPM env var and push any module in cwd to npm
npmci publish docker
# trigger webhooks
2016-06-03 22:41:25 +00:00
npmci trigger # will look for NPMCI_TRIGGER_1 to NPMCI_TRIGGER_100 in form domain|id|token|ref|name
2016-05-30 08:57:08 +00:00
```
2016-12-11 15:19:25 +00:00
## Configuration
npmci supports the use of npmextra.
To configure npmci create a `npmextra.json` file at the root of your project
```json
{
"npmci": {
2016-12-11 15:20:29 +00:00
"globalNpmTools": [
2016-12-11 15:19:25 +00:00
"npm-check-updates",
"protractor",
"npmts",
2016-12-11 15:33:56 +00:00
"gitzone"
2016-12-11 15:19:25 +00:00
]
}
}
```
**Available options**
setting | example | description
--- | --- | ---
2016-12-11 15:33:56 +00:00
globalNpmTools | "globalNpmTools": ["gitbook"] | Will look for the specified package names locally and (if not yet present) install them from npm.
2016-12-11 15:19:25 +00:00
2017-02-08 20:32:22 +00:00
[![npm](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://push.rocks)