screwdriver-executor-base - npm Package Compare versions

Comparing version 8.1.2 to 8.2.0

index.js

		@@ -87,2 +87,17 @@ 'use strict';
		/**
		* verify if a build is running
		* @method verify
		* @param {Object} config Configuration
		* @param {String} config.buildId Unique ID for a build
		* @return {Promise}
		*/
		verify(config) {
		return validate(config, executorSchema.verify).then(validConfig => this._verify(validConfig));
		}

		async _verify() {
		throw new Error('Not implemented');
		}

		/**
		* Starts a new periodic build in an executor
		@@ -89,0 +104,0 @@ * @method _startPeriodic

package.json

		{
		"name": "screwdriver-executor-base",
		"version": "8.1.2",
		"version": "8.2.0",
		"description": "Base class defining the interface for executor implementations",
		@@ -5,0 +5,0 @@ "main": "index.js",

README.md

		@@ -57,2 +57,19 @@ # Executor Base

		#### Verify
		##### Required Parameters
		\| Parameter \| Type \| Description \|
		\| :------------- \| :---- \| :-------------\|
		\| config \| Object \| Configuration Object \|
		\| config.annotations \| Object \| Optional key/value object \|
		\| config.apiUri \| String \| Screwdriver's API \|
		\| config.buildId \| String \| The unique ID for a build \|
		\| config.container \| String \| Container for the build to run in \|
		\| config.token \| String \| Temporary JWT which Executor must exchange with API to get JWT which can act on behalf of the build \|

		##### Expected Outcome
		The verify function is expected to check the pods health and status.

		##### Expected Return
		A Promise that resolves and returns the message for pod health error or success.

		#### Status
		@@ -59,0 +76,0 @@ ##### Required Parameters

New alerts