hook-ci

simple ci to be triggered by git hooks

API

Table of Contents

• defaultQueuesConfig
• queueTypes
• analyseJob
  • Parameters
• extractCINotification
  • Parameters
• streamIntoJob
  • Parameters
• stripUnusedDataFromHookRequest
  • Parameters
• wellKnownScripts
• buildAnalyse
  • Parameters
• authenticate
  • Parameters
• accessTokenGenerator
  • Parameters
• LocalNode
  • Parameters

defaultQueuesConfig

default configuration for queues

queueTypes

map queue names to processing

analyseJob

analyse the incoming job and prepare the steps to be executed in the processing queue(s)

Parameters

• job Job
• bus Object

extractCINotification

extract ci notification from line

Parameters

• line string

Returns string notification body or undefined

streamIntoJob

add log entries to a job

Parameters

• stream ReadableStream
• job Job
• step
• notificationHandler Function

stripUnusedDataFromHookRequest

strip away currently unused request data

Parameters

• request Object decodec webhook request data

Returns Object stipped down request data

wellKnownScripts

npm buildin scripts

buildAnalyse

search for build.sh

Parameters

• branch
• job
• config
• wd

authenticate

authorize user / password

Parameters

• config Object
• username string
• password string

Returns Set<string> entitlements

accessTokenGenerator

Generate a request handler to deliver JWT access tokens

Parameters

• config Object
• entitlementFilter Function

Returns any request handler return jwt token

LocalNode

Extends Node

the node we are ourselfs

Parameters

• name
• options