C# JavaScript Gherkin HTML CSS F# Other
Pull request Compare This branch is 1611 commits ahead, 1 commit behind x97mdr:master.
dirkrombauts Release 2.19.0 (#537)
* Prepare release 2.19.0

* Version 2.19.0
Latest commit fde1c2f Jul 20, 2018
Permalink
Failed to load latest commit information.
chocolatey Nuget updates and chocolatey problems (#526) Apr 28, 2018
docs Release 2.19.0 (#537) Jul 20, 2018
packages/nuget Replace nuget.exe (#495) Oct 27, 2017
src/Pickles Release 2.19.0 (#537) Jul 20, 2018
test-harness More robust scenario outline example mapping by using code from SpecF… Apr 19, 2018
.editorconfig Add .editorconfig Oct 8, 2014
.gitattributes Adding .gitattributes Apr 10, 2013
.gitignore Release 2.14.0 (#438) Feb 24, 2017
CHANGELOG.md Release 2.19.0 (#537) Jul 20, 2018
CNAME Create CNAME Aug 27, 2016
CONTRIBUTING.md Add test harness (#342) May 11, 2016
CreateTestresults.cmd Pickles is unable to deal with Danish characters (#477) Aug 10, 2017
DeployArtifacts.cmd Release 2.14.0 (#438) Feb 24, 2017
DeployOutput.cmd Use docs directory to publish website (#363) Aug 18, 2016
DeployToChocolatey.cmd Release 2.16.0 (#465) Jun 6, 2017
DeployToNuget.cmd adapt deployment script to Nuget 3.x May 10, 2016
InstallPackages.cmd Use nuget packages instead of zip files for testing Jan 4, 2016
LICENSE.txt More robust scenario outline example mapping by using code from SpecF… Apr 19, 2018
README.md Add test harness (#342) May 11, 2016
VERIFICATION.txt Adapt to new requirements of chocolatey Dec 4, 2017
build.bat Release 2.19.0 (#537) Jul 20, 2018
build.cmd Add build.cmd Mar 15, 2016
build.fsx More robust scenario outline example mapping by using code from SpecF… Apr 19, 2018
chocolatey.fsx Nuget updates and chocolatey problems (#526) Apr 28, 2018
index.html Push 2.12.0 to master (#418) Jan 26, 2017
nuget.fsx Release 2.16.0 (#465) Jun 6, 2017
pickles.png Release 2.6.0 (#324) Apr 12, 2016
test.bat Use dynamically retrieved fake Oct 16, 2015
test.fsx Release 2.16.0 (#465) Jun 6, 2017
testOutput.proj Push 2.12.0 to master (#418) Jan 26, 2017
testOutput.ps1 Push 2.12.0 to master (#418) Jan 26, 2017
testRunnerCmd.cmd Push 2.12.0 to master (#418) Jan 26, 2017
testRunnerMsBuild.cmd Release 2.6.0 (#324) Apr 12, 2016
testRunnerPowerShell.cmd Batch file to test the powershell runner Dec 2, 2014

README.md

Pickles

Pickles is an open source living documentation generator that works on feature files written in the Gherkin language, popularized in tools like Cucumber and SpecFlow.

PRs Welcome Join the chat at https://gitter.im/picklesdoc/pickles Build status

Status
Docs Documentation Status
GitHub Release GitHub release
Chocolatey (pickles) Chocolatey
Chocolatey (picklesui) Chocolatey
NuGet (Pickles) NuGet
NuGet (Pickles.CommandLine) NuGet
NuGet (Pickles.MSBuild) NuGet

Pickles can be incorporated into your build process to produce living documentation in a format that is more accessible to your clients. Gherkin language files are written in plain text and stored in your source folder. This can make them inaccessible to clients who may not know how to work with source control or who are not interested in seeing all of the source code, just the features.

Why stop with just the features though? Pickles can also read plain text files written in the Markdown format so you can add other files to your feature to add all sorts of context. Well-written features are great to have but even the best written features can leave out some important context information. Markdown is very simple to write and is designed to be easily read even in plain text files so they are a great way of adding additional context to your feature files to turn them into a real set of living documentation.

Supported Output Formats

  • HTML
  • DHTML (javascript-enabled, search capabilities)
  • JSON
  • Word
  • Excel

If there are other formats you would like to see feel free to create a GitHub Issue.

Supported Test Runner Integrations

  • NUnit (versions 2.x and 3.x)
  • xUnit (versions 1.x and 2.x)
  • MSTest
  • Cucumber JSON
  • SpecFlow+ Runner (formerly known as SpecRun)

Contributing

Pickles welcomes contributions from the community! Please refer to Contributing.md for more information on how to contribute and how to set up your environment.

License

Pickles is licensed with the Apache License, version 2.0. You can find more information on the license here: http://www.apache.org/licenses/LICENSE-2.0.html