0.0.7 • Published 5 years ago

yateamcity v0.0.7

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

yateamcity

yet another teamcity library for nodejs

install

npm i yateamcity
const teamcity = require('yateamcity');

npm version Build Status Conventional Commits

API

yateamcity : Object

yateamcity.setBuildStatus

set build status

Kind: static property of yateamcity

ParamTypeDescription
statusStringbuild status
reasonStringreason

yateamcity.setBuildProblem

set build problem

Kind: static property of yateamcity

ParamTypeDescription
problemDescriptionStringproblem description
problemTypeIdStringproblem id, in future you can what problem trend in teamcity interface

yateamcity.setBuildName

set build number

Kind: static property of yateamcity

ParamTypeDescription
buildNameStringbuild number, that string will be show in history of branch builds

yateamcity.getBuildArtifact ⇒ Promise.<Any>

get build artifacts

Kind: static property of yateamcity
Returns: Promise.<Any> - - id latest successful build

ParamTypeDescription
_optionsOptionsoptions object

yateamcity.getBuildStatistics ⇒ Promise.<Array.<Object>> | Promise.<Object>

get build statistics

Kind: static property of yateamcity
Returns: Promise.<Array.<Object>> | Promise.<Object> - - parameter value or all parameters values if name of the parametr dont send as argument

ParamTypeDefaultDescription
statisticsParameterNameStringname of the parameter
buildIdStringbuildIdbuild if

yateamcity.prepareEslintReportForTeamcity

prepare eslint report for teamcity

Kind: static property of yateamcity
See: https://confluence.jetbrains.com/display/TCD10/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ReportingTests

ParamTypeDescription
eslintReportObjectparsed object of eslint results

yateamcity.getBranches ⇒ Promise.<Array>

get branches from teamcity build

Kind: static property of yateamcity
Returns: Promise.<Array> - - list of branches

ParamTypeDescription
optionsOptionsoptions object

yateamcity.getProperties

get all availeble options from teamCity

Kind: static property of yateamcity

yateamcity.getLatestSuccessBuildId ⇒ Promise.<String>

get latest successfully build

Kind: static property of yateamcity
Returns: Promise.<String> - - id latest successful build

ParamTypeDescription
_optionsOptionsoptions object

yateamcity.isTeamcity ⇒ boolean

check where script was running

Kind: static property of yateamcity
Returns: boolean - - is script running in teamcity

yateamcity~normalizeBuildOptions(options) ⇒ PromiseLike.<object> | Promise.<object>

get normalize build options

Kind: inner method of yateamcity
Returns: PromiseLike.<object> | Promise.<object> - normalized options

ParamTypeDescription
optionsOptionsoptions object

yateamcity~Options

Kind: inner typedef of yateamcity
Properties

NameTypeDescription
serverUrlstringbase url teamcity with protocol
loginstringlogin
passwordstringpassword
buildTypeIdstringbuild type id
branchstring | functionbranch name or function what return that

Contributing

we use Conventional Commits for best changelog and version control

Develop:

  • for tests run npm test
  • for codestyle checks run npm style
  • for doc generate run npm run docs
  • for release(generate changelog, add version tag) run npm run release. We use package named standart-version and you can use this features

TODO

  • add doctoc, jsdoc generation for Readme
  • add deploy on npm with travis
  • improove coverage
  • add yaspell checks for readme
-------------|----------|----------|----------|----------|
File         |  % Stmts | % Branch |  % Funcs |  % Lines |
-------------|----------|----------|----------|----------|
All files    |    52.44 |    19.44 |    51.61 |    52.63 |
 teamcity.js |    53.85 |    26.92 |    53.85 |       55 |
 utils.js    |    47.06 |        0 |       40 |    43.75 |
-------------|----------|----------|----------|----------|
0.0.7

5 years ago

0.0.6

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago