Cucumber Ltd / jam

Publish documentationfeatures/publish_and_read/publish_documentation.feature

Release Crystal Apple (2018-02-01)

Romain Gérard

Currently viewing

Results for this document from 4 runs in latest build #7117 :

  • passed 19
  • total19 / 239

Feature: Publish documentation

Cucumber Pro enables you to publish documentation stored in your software project. It will search for Gherkin specifications represented by files with a .feature extension as well as Markdown documents represented by files with a .md extension.

Your documentation is published using Git source control software to push your software's repository to Cucumber Pro.

Rules

  • Only .feature and .md files are listed
  • Files are listed flat, with full path
  • Web UI automatically updates when you git push
  • You can configure to ignore some paths

Later

  • Multiple projects
  • Non-git repo on the user's end

Questions

  • Is a 1:1 relationship between project and repo OK?

Background:

  • Given Dolly has created test-project
  • And Dolly has uploaded her public key
  • @bitbucket

Scenario: New documents are published to outline immediately

  • Given Bob is watching test-project's documentation outline
  • When Dolly adds features/hello.feature to test-project:
    Feature: Hello
  • Then Bob should see features/hello.feature in the documentation outline

Scenario: Read published Gherkin document

  • Given Bob is watching test-project's documentation outline
  • When Dolly adds features/hello.feature to test-project:
    Feature: Hello
  • Then Bob should be able to read features/hello.feature:
    Feature: Hello

Scenario: Read published Markdown document

  • Given Bob is watching test-project's documentation outline
  • When Dolly adds features/hello.md to test-project:
    # Hello
  • Then Bob should be able to read features/hello.md:
    # Hello

Scenario: Can't read unrecognized file type

  • Given Bob is watching test-project's documentation outline
  • When Dolly adds features/hello.txt to test-project:
    Hello
  • Then Bob should not be able to read features/hello.txt

Scenario: See latest repo revision

  • And Bob is watching test-project's documentation outline
  • When Dolly adds some documents to test-project
  • Then Bob should be able to see details of the latest change to the project

Scenario: Exclude files from publication

Files are ignored using the .gitignore syntax by adding .cucumberproignore to the root of your Git repository.

  • And Bob is watching test-project's documentation outline
  • And Dolly has added the following files to test-project:
    examples/hello.md
    world.md
  • When Dolly excludes test-project's files in the "/examples" directory
  • Then Bob should see the documentation outline:
    world.md