Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


setBuildVersion - Sets the current build's version string. 

Parameters:  value, verbose

Example: 

@@continua[setBuildVersion value='1.2.3']


setBuildStatus 
- Sets the current action's build status, which is shown on the build details page when a build is running.

Parameters: name, verbose

Example: 

@@continua[setBuildStatus value='Copying Files...']

pinBuild - Pins the current build, so that it is listed at the top of the build history and excluded from build cleanup. Optionally provide a comment to be associated with the pin and set the appendComment attribute to 'true' to append it to any existing comment.

Parameters: comment, appendComment, verbose

Example: 

@@continua[pinBuild comment='Keep this awesome build' appendComment='true']

unpinBuild - Removes any pins from the current build.

Parameters: verbose

Example : 

@@continua[unpinBuild]

tagBuild - Adds the supplied tag to the current build. Optionally set the replaceExisting attribute to 'true' to remove any existing tags first.

Parameters: tag, replaceExisting, verbose

Example: 

@@continua[tagBuild tag='deployed' replaceExisting='true']

removeBuildTag - Remove a tag or all tags from current build. Either provide the name of the tag to remove or set the removeAll attribute to 'true' to remove all existing tags.

Parameters: tag, removeAll, verbose

Examples: 

@@continua[removeBuildTag tag='deployed']

@@continua[removeBuildTag removeAll='true']

addBuildComment- Adds the supplied comment to the current build. Optionally set the replaceExisting attribute to 'true' to remove any existing comments first.

Parameters: comment, replaceExisting, verbose

Example: 

@@continua[addBuildComment comment='This build was deployed to staging' replaceExisting='true']

importUnitTestResults - Imports unit tests and totals from unit test result files and registers them with the server. 

AnchorImportUnitTestResults ImportUnitTestResults

Parameters: 

  • type: One of junit, mstest, nunit or xunit. Identifies the type of unit test runner that created the results file. This is required.
  • filePatterns: One or more paths to result files separated by the pipe character. Each path may contain ANT pattern wildcards. This is required.
  • failIfTestFails:When true, the stage fails if any unit test fails. Defaults to true.
  • failIfTestErrors:When true, the stage fails if any unit test errors. Defaults to true.
  • quiet: When true, any non-error log messages are suppressed. Defaults to false.

Example: 

@@continua[importUnitTestResults type='nunit' filePatterns='C:\pathto\tests\**.xml|C:\another\pathto\tests\**.xml' failIfTestFails='false' failIfTestErrors='false' quiet='false' verbose='false']

Common parameters

If the verbose parameter is set to true for any of the message types above, additional text describing the action will be written to the build log.

Example : 

@@continua[setBuildVersion value='1.2.3' verbose='true']