Code Monkey home page Code Monkey logo

picklesgeneratortask's Introduction

Pickles documentation generator

Overview

This extension will add a Build/Release task in your TFS/VSTS instance that will allow you to generate Pickles documentation. Task ships with the necessary Pickles executable files.

Requirements

No specific requirements are present for this task to run.

The different parameters of the task are explained below:

  • Feature Directory: Directory to start scanning recursively for features.
  • Documentation Format: Allows the user to select what format the generated output will be written in. E.g. HTML, Word, DHTML, Excel, etc.
  • Output Directory: The folder where Pickles will put the generated output. If not specified, by default, is going to be persisted in AGENT_BUILDDIRECTORY in case of a build, meanwhile in case of a release it is going to be placed in AGENT_RELEASEDIRECTORY
  • System Under Test Name: This is the name of the system under test. Since Pickles is designed to be used with any platform/language that supports Gherkin feature files we cannot rely on reading in an assembly or a jar file to retrieve metadata about the system under test. Instead, The user can use this argument to name the system under test.
  • System Under Test Version: This is the version of the system under test. Since Pickles is designed to be used with any platform/language that supports Gherkin feature files we cannot rely on reading in an assembly or a jar file to retrieve metadata about the system under test. Instead, The user can use this argument to set a version number for the system under test.
  • Test Results File: Path to the XML results file. Supports file matching patterns.
  • Test Results Format: The format used for the report coming out of the test run of the features. There are many different testing frameworks supported by SpecFlow, plus all of the other gherkin style frameworks out there. NUnit and xUnit output formats are accepted as well as output from MsTest and SpecRun. As of version 2.4, Pickles also supports output from VsTest.Console.exe, the new command line runner introduced by Visual Studio 2012.
  • Language: Allows the user to tell Pickles the default language of the .feature files. Any language settings inside the .feature files take precedence.
  • Enable Comments: As of version 2.6, Pickles includes Gherkin #-style comments. As of version 2.7, this inclusion is configurable.
  • Include Experimental Features: As of version 2.5, Pickles includes experimental features. The goal of experimental features is to get rapid feedback about ideas. They are subject to change or removal at any time. The experimental features are not always completely thought through - including them and receiving feedback about them enables us to make better decisions about those features. This argument is a flag. Including the argument means that the experimental features should be included. If the argument is not included, then the experimental features will not be included.

Release notes

  • 1.0.3 - Fixed an issues where output dir couldn't be insisting path #3. Pickles binaries upgraded to v2.20.1 #1. Test result file parameter now accepts advanced pattern matching in order to allow for the file search #2
  • 1.0.2 - Improved markdown file. No changes for the build task
  • 1.0.1 - Minor improvements on the extension. No changes for the build task
  • 1.0.0 - Initial Release - Ships with Pickles 2.18.0

Contributing

Feel free to notify any issue in the issues section of this GitHub repository. In order to build this task, you will need Node.js and gulp installed. Once cloned the repository, just run 'npm install' then 'gulp package' and in the newly created folder called _packages you will find a new version of the extension.

picklesgeneratortask's People

Contributors

dvdvorle avatar mmajcica avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

picklesgeneratortask's Issues

No output generated, no errors reported

I have a few feature files that I have tested using pickles on the command-line and it is generating the requested output documentation ok, however when I using PicklesGenerator I am not getting any output files & no errors reported in DevOps.

Is there a way to get more/verbose logging from the task?

Thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.