AeroGear Digger Node.js client

AeroGear digger node.js command line client. Create Jenkins job and build your application using Jenkinsfile located in your source code.

Project Info

| | Project Info | | --------------- | ------------- | | License: | Apache License, Version 2.0 | | Build: | Node | | Documentation: | https://github.com/aerogear/aerogear-digger | | Issue tracker: | https://issues.jboss.org/browse/AGDIGGER | | Mailing lists: | aerogear-users (subscribe) | | | aerogear-dev (subscribe) | | IRC: | #aerogear channel in the freenode network. |

Installation

Install command line tool

npm install -g aerogear-digger-node-client

Sample use case

Login to Jenkins. Your credentials will be stored in configuration.

digger login http://myjenkins.com

Create job that would use your repository as source code

digger job create my-job https://github.com/android/project master

Trigger build

digger job build my-job

Supported commands

  # Setup jenkins credentials and login into jenkins
  digger login <url> [user] [password]

  # Create jenkins job for git repository with Jenkinsfile
  digger job create <name> [repository] [branch]

  Trigger build for Jenkins job
  digger job build <jobname>                

  # Stream jenkins logs for triggered build
  digger log <job> <buildNumber>       
  
  # Get job artifacts for specified build
  digger artifact <job> <buildNumber>   

  # Generate bash completion script
  digger completion                     

Development

1. Install node.js
2. Checkout repository
3. Link library to use directly from source code

npm link .

JSDoc generation

Execute

npm run docs

This will generate some HTML from the JSDocs in the code. Go to .docs/index.html on your browser to see them.