Try our conversational search powered by Generative AI!

Shoma Gujjar
Jan 29, 2016
  3749
(2 votes)

Pickles : Living documentation generator

Recently there came a requirement from the business,they wanted to know a high level view of the specification/requirements of an Project. A colleague suggested that feature files written in gherkin statements where ideal for this purpose.

Therefore we had to look for a tool that would translate the feature files to a more business-friendly format (word,pdf,html), so that the business could have a look at it at their convenience without having to reach out developers.

There were 2 main tools that suited this requirement namely:

  1. Relish
  2. Pickles

Relish is based on Ruby plus it comes with a subscription fee. They do have a Free plan, but all your projects will be public!

Pickles is open-source and easily installed via nuget. The documentation can be found here. Pickles can be run via commandline, GUI,PowerShell or MSBuild

Sample Example using CommandLine

Pickle supports Html, Dhtml,word,JSON and Excel formats.

Install Pickles in your project:

using nuget console manager : Install-Package Pickles.CommandLine

Open Command Prompt in Administrator mode – > Navigate to your Specs project and execute the below command

..\packages\Pickles.CommandLine.2.3.0\tools\pickles.exe --feature-directory=C:\BitBucket\TestProj.Specs --output-directory=c:\my-features-output --documentation-format=dhtml

where --feature-directory =  is the path to your test project

--output-directory =  path to your output file

--documentation-format =  format of the output (optional) . The default output is html

If you want the output in word format then set --documentation-format=word

Plus

The above command can be copied to a .bat-file.

Pickles can also be integrated into automated build or continuous integration tool like TeamCity.

Jan 29, 2016

Comments

Please login to comment.
Latest blogs
Optimizely and the never-ending story of the missing globe!

I've worked with Optimizely CMS for 14 years, and there are two things I'm obsessed with: Link validation and the globe that keeps disappearing on...

Tomas Hensrud Gulla | Apr 18, 2024 | Syndicated blog

Visitor Groups Usage Report For Optimizely CMS 12

This add-on offers detailed information on how visitor groups are used and how effective they are within Optimizely CMS. Editors can monitor and...

Adnan Zameer | Apr 18, 2024 | Syndicated blog

Azure AI Language – Abstractive Summarisation in Optimizely CMS

In this article, I show how the abstraction summarisation feature provided by the Azure AI Language platform, can be used within Optimizely CMS to...

Anil Patel | Apr 18, 2024 | Syndicated blog

Fix your Search & Navigation (Find) indexing job, please

Once upon a time, a colleague asked me to look into a customer database with weird spikes in database log usage. (You might start to wonder why I a...

Quan Mai | Apr 17, 2024 | Syndicated blog

The A/A Test: What You Need to Know

Sure, we all know what an A/B test can do. But what is an A/A test? How is it different? With an A/B test, we know that we can take a webpage (our...

Lindsey Rogers | Apr 15, 2024

.Net Core Timezone ID's Windows vs Linux

Hey all, First post here and I would like to talk about Timezone ID's and How Windows and Linux systems use different IDs. We currently run a .NET...

sheider | Apr 15, 2024