Downloads:

20,216

Downloads of v 2.0.2:

391

Last Update:

21 Nov 2015

Package Maintainer(s):

Software Author(s):

  • PicklesDoc and contributors

Tags:

SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation

Pickles - The Open Source Living Documentation Generator

This is not the latest version of Pickles - The Open Source Living Documentation Generator available.

2.0.2 | Updated: 21 Nov 2015

Downloads:

20,216

Downloads of v 2.0.2:

391

Maintainer(s):

Software Author(s):

  • PicklesDoc and contributors

Tags:

SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation

Pickles - The Open Source Living Documentation Generator 2.0.2

This is not the latest version of Pickles - The Open Source Living Documentation Generator available.

Some Checks Have Failed or Are Not Yet Complete

1 Test Unknown and 1 Passing Test

Hide Checks
Hide Checks

Validation Testing Unknown

Verification Testing Passed

Details

To install Pickles - The Open Source Living Documentation Generator, run the following command from the command line or from PowerShell:

>

To upgrade Pickles - The Open Source Living Documentation Generator, run the following command from the command line or from PowerShell:

>

To uninstall Pickles - The Open Source Living Documentation Generator, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade pickles -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade pickles -y --source="'STEP 3 URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode


- name: Ensure pickles installed
  win_chocolatey:
    name: pickles
    state: present
    version: 2.0.2
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'pickles' do
  action    :install
  version  '2.0.2'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: pickles,
    Version: 2.0.2,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller pickles
{
   Name     = 'pickles'
   Ensure   = 'Present'
   Version  = '2.0.2'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'pickles':
  provider => 'chocolatey',
  ensure   => '2.0.2',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install pickles version="2.0.2" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved as a trusted package on 21 Nov 2015.

Description

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.

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.

Pickles can produce output in different formats:

  • Static HTML: a set of HTML files with minimal JavaScript
  • Dynamic HTML: a JavaScript-rich single page app with integrated search
  • Word: Microsoft Word
  • Excel: Microsoft Excel
  • JSON: a custom JSON format

Optionally, Pickles can integrate test results, so that your stakeholders know which scenarios pass validation. Pickles supports these test formats:

  • NUnit
  • MSTest
  • XUnit
  • SpecRun
  • Cucumber JSON
tools\Pickles.exe 
md5: E52492BD14651155BB74F66017A11169 | sha1: E638DCB401876F2C0A5DB2391C7C8E7C17F0BABE

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
Pickles - The Open Source Living Documentation Generator 2.20.1 3968 Thursday, October 18, 2018 Approved
Pickles - The Open Source Living Documentation Generator 2.20.0 150 Tuesday, October 9, 2018 Approved
Pickles - The Open Source Living Documentation Generator 2.19.0 389 Friday, July 20, 2018 Approved
Pickles - The Open Source Living Documentation Generator 2.18.2 628 Saturday, April 28, 2018 Approved
Pickles - The Open Source Living Documentation Generator 2.18.1 195 Friday, April 20, 2018 Approved
Pickles - The Open Source Living Documentation Generator 2.18.0 380 Friday, February 2, 2018 Approved
Pickles - The Open Source Living Documentation Generator 2.17.0 443 Thursday, November 30, 2017 Approved
Pickles - The Open Source Living Documentation Generator 2.16.2 589 Sunday, August 13, 2017 Approved
Pickles - The Open Source Living Documentation Generator 2.16.1 253 Monday, August 7, 2017 Approved
Pickles - The Open Source Living Documentation Generator 2.16.0 552 Tuesday, June 6, 2017 Approved

This package has no dependencies.

Discussion for the Pickles - The Open Source Living Documentation Generator Package

Ground Rules:

  • This discussion is only about Pickles - The Open Source Living Documentation Generator and the Pickles - The Open Source Living Documentation Generator package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Pickles - The Open Source Living Documentation Generator, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus