Skip to content

Commit

Permalink
fixed #98, fixed #178: htmlSanityCheck now checks its own documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@gernotstarke
gernotstarke committed Aug 15, 2018
1 parent ed55abe commit c16462e
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ dependencies {
'org.codehaus.groovy:groovy-all:2.4.12',
'org.spockframework:spock-core:1.1-groovy-2.4',
'com.tngtech.archunit:archunit-junit:0.8.3')
// need cglib
// 'com.github.cglib:cglib-nodep:3.2.5')

compile gradleApi()
compile group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.3'
Expand Down Expand Up @@ -85,17 +83,24 @@ apply from: 'config/codenarc.gradle'

// end:BuildPlugins[]


htmlSanityCheck {
sourceDir = new File( buildDir, "html5")

// files to check - in Set-notation
// ensure asciidoctor->html runs first
// and images are copied to build directory

dependsOn asciidoctor

//sourceDocuments = [ "one-file.html", "another-file.html", "index.html"]

sourceDir = new File("${buildDir}/html5")

// where to put results of sanityChecks...
checkingResultsDir = new File( buildDir, "reports/tests/htmlSanityCheck" )
checkingResultsDir = new File( buildDir, "reports/htmlSanityCheck" )

// don't break the build if html errors are found!
// fail the build if any error is encountered
failOnErrors = false

This comment has been minimized.

Sign in to view

Copy link
@thc202

thc202 Sep 10, 2018

Contributor

Based on the above comment change this should have been changed to true?

}

task copyResourceImages(type: Copy) {
Expand Down

4 comments on commit c16462e

@gernotstarke
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx @thc202 , you're right. HtmlSanityCheck now checks its own documentation...

Please expect major improvements in 1.0.0-RC-2 and 1.0.0-RC-3, which are both in active development right now (in case you're interested, checkout the branch 1.0.0-RC-2.)

In case you have additional requirements, please create issues :-)

@thc202
Copy link
Contributor

@thc202 thc202 commented on c16462e Sep 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, looking forward! Is there are public roadmap of what will be included in the RCs?
I noticed, already taking a look at that :)

Will do, I actually raised two minor pull requests already :)

@thc202
Copy link
Contributor

@thc202 thc202 commented on c16462e Sep 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI (which I should have disclosed sooner) I'm investigating the usage of HtmlSanityCheck in our (@zaproxy) repos (we have many HTML files for JavaHelp), that's why the interest and the issues/pull requests raised so far.

@gernotstarke
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd love to see HtmlSanityCheck used with @zaproxy - what can I do to support you?

The currently (unpublished) version 1.0.0-RC-2 allows more flexible configuration of http link checking
(e.g. which status codes shall result in errors, warnings or success) and others.

Are you missing any specific checks? Need additional documentation?

Please sign in to comment.