Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove ascii doc generated section header #755

Merged
merged 3 commits into from
May 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions release_notes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## next (unreleased)
- [#755](https://github.com/Flank/flank/pull/755) Remove ascii doc generated section header. ([jan-gogo](https://github.com/jan-gogo))
- [#731](https://github.com/Flank/flank/pull/731) Refactor jUnit HTML report. ([Writhe](https://github.com/Writhe))
- [#754](https://github.com/Flank/flank/pull/754) Sync README.md flank.yml flank.ios.yml. ([jan-gogo](https://github.com/jan-gogo))
- [#746](https://github.com/Flank/flank/pull/746) Ignore apk with filtered out tests instead of failing. ([pawelpasterz](https://github.com/pawelpasterz))
Expand Down
24 changes: 22 additions & 2 deletions test_runner/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ tasks.create("updateFlank", Exec::class.java) {
}

// begin --- ASCII doc generation ---
val generateManpageAsciiDoc by tasks.registering(JavaExec::class) {
val generateCliAsciiDoc by tasks.registering(JavaExec::class) {
dependsOn(tasks.classes)
classpath(
configurations.compile,
Expand All @@ -254,7 +254,27 @@ val generateManpageAsciiDoc by tasks.registering(JavaExec::class) {
)
}

val processCliAsciiDoc by tasks.registering {
dependsOn(generateCliAsciiDoc)
group = "Documentation"
doLast {
File("${project.rootDir}/docs/ascii").listFiles()?.forEach { file ->
file.apply {
readLines().run {
val toRemove = IntRange(
indexOf("// tag::picocli-generated-man-section-header[]"),
indexOf("// end::picocli-generated-man-section-header[]")
)
filterIndexed { index, _ -> index !in toRemove }
}.joinToString("\n").let { text ->
writeText(text)
}
}
}
}
}

tasks.assemble {
dependsOn(generateManpageAsciiDoc)
dependsOn(processCliAsciiDoc)
}
// end --- ASCII doc generation ---
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-android-doctor.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-android-doctor(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -49,4 +38,4 @@ Validates Android Flank YAML.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-android-run.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-android-run(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -235,4 +224,4 @@ Learn more at https://firebase.google.com/docs/test-lab/robo-ux-test#scripting.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-android.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-android(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -45,4 +34,4 @@ flank.jar

// end::picocli-generated-man-section-commands[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-auth-login.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-auth-login(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -42,4 +31,4 @@ Authenticates using your user account. For CI, a service account is recommended.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-auth.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-auth(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -42,4 +31,4 @@ flank.jar

// end::picocli-generated-man-section-commands[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-cancel.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-cancel(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -44,4 +33,4 @@ Reads in the matrix_ids.json file. Cancels any incomplete matrices.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-firebase-cancel.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-cancel(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -44,4 +33,4 @@ Reads in the matrix_ids.json file. Cancels any incomplete matrices.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-firebase-refresh.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-refresh(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -44,4 +33,4 @@ Reads in the matrix_ids.json file. Refreshes any incomplete matrices.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-test-android-doctor(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -49,4 +38,4 @@ Validates Android Flank YAML.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-firebase-test-android-run.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-test-android-run(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -247,4 +236,4 @@ Learn more at https://firebase.google.com/docs/test-lab/robo-ux-test#scripting.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-firebase-test-android.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-test-android(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -45,4 +34,4 @@ flank.jar

// end::picocli-generated-man-section-commands[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-firebase-test-ios-doctor.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-test-ios-doctor(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -49,4 +38,4 @@ Validates iOS YAML and connection to iOS catalog.

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-firebase-test-ios-run.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-test-ios-run(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -168,4 +157,4 @@ Configuration is read from flank.yml

// end::picocli-generated-man-section-options[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
13 changes: 1 addition & 12 deletions test_runner/docs/ascii/flank.jar_-firebase-test-ios.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-test-ios(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand Down Expand Up @@ -45,4 +34,4 @@ flank.jar

// end::picocli-generated-man-section-commands[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
// tag::picocli-generated-full-manpage[]
// tag::picocli-generated-man-section-header[]
:doctype: manpage
:revnumber:
:manmanual: Flank.jar
Manual
:mansource:
:man-linkstyle: pass:[blue R < >]
= flank.jar
-firebase-test-network-profiles-list(1)

// end::picocli-generated-man-section-header[]

// tag::picocli-generated-man-section-name[]
== Name
Expand All @@ -34,4 +23,4 @@ flank.jar

// end::picocli-generated-man-section-description[]

// end::picocli-generated-full-manpage[]
// end::picocli-generated-full-manpage[]
Loading