Skip to content

Commit

Permalink
Merge pull request #132 from trivago/1.7.0-release
Browse files Browse the repository at this point in the history
1.7.0 release
  • Loading branch information
Benjamin Bischoff authored Feb 20, 2019
2 parents 3495183 + 07022f3 commit c7683e5
Show file tree
Hide file tree
Showing 94 changed files with 2,690 additions and 2,284 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

Back to [Readme](README.md).

## [1.7.0] - 2019-02-20

### Added

* Feature name link is now shown on scenario detail pages (#125)
* three new options to expand or collapse hooks and docstrings on scenario detail pages (default: false) (#117)
```xml
<expandBeforeAfterHooks>true|false</expandBeforeAfterHooks>
<expandStepHooks>true|false</expandStepHooks>
<expandDocStrings>true|false</expandDocStrings>
```

* Added data attributes for common elements (`data-cluecumber-item`) to simplify custom css configurations (related to #129)

### Fixed

* `All Tags` page shows the correct number of tagged results (#124)
* Layout break on long scenario descriptions without spaces

### Changed

* Updated all js dependencies
* Small design changes for expansion buttons to make them less prominent

## [1.6.5] - 2019-01-21

### Fixed
Expand Down Expand Up @@ -329,6 +353,7 @@ Back to [Readme](README.md).

Initial project version on GitHub and Maven Central.

[1.7.0]: https://github.com/trivago/cluecumber-report-plugin/tree/1.7.0
[1.6.5]: https://github.com/trivago/cluecumber-report-plugin/tree/1.6.5
[1.6.4]: https://github.com/trivago/cluecumber-report-plugin/tree/1.6.4
[1.6.3]: https://github.com/trivago/cluecumber-report-plugin/tree/1.6.3
Expand Down
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,13 @@ This can be done by running

directly from the command line.

You can also pass the properties directly on the command line, e.g.

`mvn cluecumber-report:reporting -DsourceJsonReportDirectory=path_to_json_files -D...`

## Mandatory Configuration Parameters

There are two mandatory parameters that have to be specified within the Maven POM ```configuration``` section:
There are two mandatory parameters that have to be specified within the Maven POM ```configuration``` section or system properties:

__Note:__ Typically, both properties point to directories inside the Maven ```target``` directory.

Expand Down Expand Up @@ -169,15 +173,15 @@ The `customCSS` property can be used to define a custom CSS file that will be au
If you have a custom CSS file called `custom/custom.css` in your project, you could use it to change the report's background and header colors:
```css
body {
background-color: black;
background-color: dimgray;
}

h3, h4 {
color: white;
color: orange;
}
```

To use this files, specify it like so:
To use this files, specify it like so in your pom file or as a system property:

```xml
<customCss>custom/custom.css</customCss>
Expand All @@ -187,6 +191,26 @@ When generating the report, this file is automatically included as ```cluecumber

![Custom CSS](documentation/img/custom_css.png)

Likewise, if you want to hide elements from the report, e.g. the total time on the start page, you can also add this to the custom css like so:

```css
[data-cluecumber-item="total-scenario-duration"] {
display: none;
}
```

### expandBeforeAfterHooks, expandStepHooks, expandDocStrings

These options can be set to 'true' to expand or collapse before/after hooks, step hooks or docstrings respectively on scenario detail pages.

If they are not set, they default to false meaning the report user has to use the buttons on a scenario detail page to expand those sections on demand.

```xml
<expandBeforeAfterHooks>true|false</expandBeforeAfterHooks>
<expandStepHooks>true|false</expandStepHooks>
<expandDocStrings>true|false</expandDocStrings>
```

# Example project

You can test the complete flow and POM configuration by checking out the [Cluecumber example project](example-project).
Expand Down
8 changes: 4 additions & 4 deletions docs/css/bootstrap.min.css

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion docs/css/cluecumber.css
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ html {
min-height: 100%;
}

h2, h3 {
h2, h3, h4, h5 {
word-break: break-all;
}

Expand Down Expand Up @@ -173,6 +173,16 @@ button.btn {
white-space: inherit;
}

.btn.focus {
outline: none;
box-shadow: none;
}

.btn-outline-secondary, .btn-outline-secondary.focus, .btn-outline-secondary:focus {
border: none;
box-shadow: none;
}

button.btn.collapsed:before {
content: 'Show ';
}
Expand Down
2 changes: 1 addition & 1 deletion docs/css/dataTables.bootstrap4.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c7683e5

Please sign in to comment.