Skip to content

Commit

Permalink
Merge pull request #219 from takahirom/takahirom/fix-markdown-issue/2…
Browse files Browse the repository at this point in the history
…023-12-03

Fix markdown issue
  • Loading branch information
takahirom authored Dec 3, 2023
2 parents 6807a0b + 1ebe840 commit 24511b0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- Generated by ./gradlew generateReadme. Do not edit this file. -->
<div name="topic_top">

<!-- Generated by docs/topics/top.md. Do not edit this file. -->
# Roborazzi

Expand Down Expand Up @@ -44,6 +45,7 @@ In the DroidKaigi 2023 app, Roborazzi was introduced from the early stages of de

</div>
<div name="topic_try_it_out">

<!-- Generated by docs/topics/try_it_out.md. Do not edit this file. -->
# Try it out

Expand Down Expand Up @@ -234,6 +236,7 @@ compose-samples [here](https://github.com/takahirom/compose-samples/pull/1/files

</div>
<div name="topic_how_to_use">

<!-- Generated by docs/topics/how_to_use.md. Do not edit this file. -->
# How to use

Expand Down Expand Up @@ -978,7 +981,7 @@ You can configure the following options in your `gradle.properties` file:
This option enables you to configure the behavior of Roborazzi. By default, all settings are set to false.
For additional configuration options, please refer to the 'Apply Roborazzi Gradle Plugin' section.
```properties
```
roborazzi.test.record=true
# roborazzi.test.compare=true
# roborazzi.test.verify=true
Expand All @@ -990,15 +993,15 @@ roborazzi.test.record=true
This option lets you set the resize scale for the image being recorded. The default value is 1.0.
```properties
```
roborazzi.record.resizeScale=0.5
```
#### roborazzi.record.filePathStrategy
This setting allows you to specify the file path strategy for the recorded image. The default strategy is `relativePathFromCurrentDirectory`. If you choose `relativePathFromRoborazziContextOutputDirectory`, the file will be saved in the output directory specified by `RoborazziRule.Options.outputDirectoryPath`.
```properties
```
roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory
```
Expand All @@ -1010,12 +1013,13 @@ This option enables you to define the naming strategy for the recorded image. Th
- If you choose `escapedTestPackageAndClassAndMethod`, the file name will be `com_example_MyTest.testMethod.png`.
- If you choose `testClassAndMethod`, the file name will be `MyTest.testMethod.png`.
```properties
```
roborazzi.record.namingStrategy=testClassAndMethod
```
</div>
<div name="topic_faq">
<!-- Generated by docs/topics/faq.md. Do not edit this file. -->
# FAQ
Expand Down Expand Up @@ -1089,9 +1093,8 @@ By following these steps, you should be able to identify and resolve the issue c
**A:** This warning may occur with Gradle 7.5. Upgrade to Gradle 7.6.2 to resolve this issue. Change the distribution URL in `gradle-wrapper.properties`:
```diff
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
```
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
```
### Q: Can I run Roborazzi with Bazel?
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ tasks.register("generateReadme") {
println("topic: $topic pattern: $pattern result: $result")

def generatedComment = "<!-- Generated by $topicsPath/${topic.name}.md. Do not edit this file. -->"
def newTopicContent = "<div name=\"topic_${topic.name}\">\n$generatedComment\n${topic.content}\n<\\/div>"
def newTopicContent = "<div name=\"topic_${topic.name}\">\n\n$generatedComment\n${topic.content}\n<\\/div>"
newReadmeContent = pattern.matcher(newReadmeContent)
.replaceAll(newTopicContent)
}
Expand Down

0 comments on commit 24511b0

Please sign in to comment.