From b901699798676ccb2375ec9db8d306b0e1483648 Mon Sep 17 00:00:00 2001 From: Gerd Aschemann Date: Tue, 13 Aug 2024 11:25:47 +0200 Subject: [PATCH] #332 Add ChangeLog to MicroSite --- CHANGELOG.md | 10 ++- src/docs/development/CHANGELOG.md | 93 ++++++++++++++++++++++++++ src/docs/development/gradle.properties | 11 +++ src/docs/development/publishing.adoc | 28 +++++--- 4 files changed, 133 insertions(+), 9 deletions(-) create mode 100644 src/docs/development/CHANGELOG.md create mode 100644 src/docs/development/gradle.properties diff --git a/CHANGELOG.md b/CHANGELOG.md index c630546a..bfcfceb8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +title=ChangeLog +date=2024-06-23 +type=page +tags=ChangeLog +status=published +filename=CHANGELOG.md +order=90 +~~~~~~ # HtmlSanityCheck - ChangeLog ## 2.0.0-rc0 @@ -81,5 +89,5 @@ Restructured code into several Gradle subprojects. - [#68](https://github.com/aim42/htmlSanityCheck/issues/68) - corrected reference counter for broken cross-references (n occurrences are now counted as n issues) -# 0.5.3 (first public version) +## 0.5.3 (first public version) Functional as Gradle-plugin diff --git a/src/docs/development/CHANGELOG.md b/src/docs/development/CHANGELOG.md new file mode 100644 index 00000000..bfcfceb8 --- /dev/null +++ b/src/docs/development/CHANGELOG.md @@ -0,0 +1,93 @@ +title=ChangeLog +date=2024-06-23 +type=page +tags=ChangeLog +status=published +filename=CHANGELOG.md +order=90 +~~~~~~ +# HtmlSanityCheck - ChangeLog + +## 2.0.0-rc0 + +### Publication + +- [Maven Central](https://central.sonatype.com/namespace/org.aim42.htmlSanityCheck) + +### Changes + +#### Features + +- [#322](https://github.com/aim42/htmlSanityCheck/issues/322) - Add Git properties +- [#321](https://github.com/aim42/htmlSanityCheck/issues/321) - Enable JitPack builds +- [#320](https://github.com/aim42/htmlSanityCheck/issues/320) - Add SonarQube (SonarCloud) analysis +- [#317](https://github.com/aim42/htmlSanityCheck/issues/317) - Add test coverage reports (aka. JaCoCo) +- [#315](https://github.com/aim42/htmlSanityCheck/issues/315) - Introduce dependabot to become aware of dependency updates +- [#312](https://github.com/aim42/htmlSanityCheck/issues/312) - Port HSC from Groovy to Java (in order to prepare [#314](https://github.com/aim42/htmlSanityCheck/issues/314), the proposed Maven plugin) +- [#309](https://github.com/aim42/htmlSanityCheck/issues/309) - Modularize htmlSanityChecker → gradle plugin + core (GA/BK/JT) + +#### BugFixes + +- [#323](https://github.com/aim42/htmlSanityCheck/issues/323) - Bump jquery due to (moderate) security warnings + + +### New Contributors +- [Gerd Aschemann](https://github.com/ascheman) (GA) +- [Björn Kasteleiner](https://github.com/bjkastel) (BK) +- [Thomas Ruhroth](https://github.com/truhroth) (TR) +- [Johannes Thorn](https://github.com/johthor) (JT) + +And some others who participated in our +[CyberLand](https://cyberland.ijug.eu/) open source camps during the last months. + +## 1.1.6 +April 2021: GS, compiled with Java 8 - as I accidentally compiled V 1.1.4 with jdk 14... no other changes or fixes + +## 1.1.4 +April 2021: GS, merge [#283](https://github.com/aim42/htmlSanityCheck/issues/283), remove codenarc, +remove docToolChain-submodule + +## 1.1.3.snapshot +Jan 2021: try to fix [#282](https://github.com/aim42/htmlSanityCheck/issues/282) + +## 1.0.0-RC-2 +Oct 2018: enhanced configurability, fixed several bugs, released version on Gradle plugin portal + + +## 0.9.8 +July 2018: added CodeNarc V1.2, upgraded to Gradle 4.9, fixed travis build, improved footer of the HTML report + + +## 0.9.7 +Dec 6th 2017: simplified gradle build, removed SonarQube, CodeNarc etc., added ArchUnit tests + +May 3rd 2017: Fix broken logos in reports: [#149](https://github.com/aim42/htmlSanityCheck/issues/149) +May 3rd 2017: Clean up three logging statements. + +## 0.9.6 +Dec 13th 2016: Fix absolute local image check: [#130](https://github.com/aim42/htmlSanityCheck/issues/130) +Dec 12th 2016: Gradle plugin sends output to info log. +April 8th 2016: Add JUnit XML reporting to support automated tools. + +## 0.9.3 +June 14th 2015: published on Gradle Plugin Repository +May 14th 2015: reverted subproject structure, as it led to numerous build problems. + +## 0.8.0 +It could not be published on Bintray due to these issues. + + +## 0.8.0-SNAPSHOT +Restructured code into several Gradle subprojects. + +- [#29](https://github.com/aim42/htmlSanityCheck/issues/29) - detect some more variants of URLs, e.g., IP-address prefixed etc. +- [#42](https://github.com/aim42/htmlSanityCheck/issues/42) - reference counter for "missing local ref checker" +- [#60](https://github.com/aim42/htmlSanityCheck/issues/60) - upgraded to jsoup parser v. 1.8.1 (from 1.7.3) +- [#62](https://github.com/aim42/htmlSanityCheck/issues/62) - upgraded to AsciiDoctor-Gradle-Plugin-1.5.2 (from 1.5.0) +- [#65](https://github.com/aim42/htmlSanityCheck/issues/65) - nicer message for reference-counter +- [#66](https://github.com/aim42/htmlSanityCheck/issues/66) - log messages now have appropriate levels (most are .debug now) +- [#68](https://github.com/aim42/htmlSanityCheck/issues/68) - corrected reference counter for broken cross-references (n occurrences are now counted as n issues) + + +## 0.5.3 (first public version) +Functional as Gradle-plugin diff --git a/src/docs/development/gradle.properties b/src/docs/development/gradle.properties new file mode 100644 index 00000000..26e227a7 --- /dev/null +++ b/src/docs/development/gradle.properties @@ -0,0 +1,11 @@ +# tag::version[] +htmlSanityCheckVersion=2.0.0-rc0 +# end::version[] + +group = org.aim42.htmlSanityCheck +description = HTML Sanity Check + +org.gradle.jvmargs=-Xmx2G +org.gradle.parallel=true + +org.gradle.java.installations.auto-detect=false \ No newline at end of file diff --git a/src/docs/development/publishing.adoc b/src/docs/development/publishing.adoc index 57a38284..288d81f0 100644 --- a/src/docs/development/publishing.adoc +++ b/src/docs/development/publishing.adoc @@ -1,5 +1,17 @@ :filename: development/publishing.adoc -=== Publishing kbd:[htmlSC] Releases +:jbake-title: Publishing HSC Releases +:jbake-type: page_toc +:jbake-status: published +:jbake-menu: development +:jbake-order: 80 +== {jbake-title} +:icons: font +:toc: +:toclevels: 3 +:toc-position: right +:experimental: +:markdown-suffix: md +ifdef::backend-html5[:markdown-suffix: html] HSC (Core and Gradle plugin) can be published to https://central.sonatype.com/search?q=org.aim42.htmlSanityCheck[Maven Central] (MC) for retrieval by its consumers. @@ -8,9 +20,9 @@ as they are redirecting plugin downloads automatically to Maven Central. WARNING: Only note that newer versions (>= 2.0.0) currently do not show up in the https://plugins.gradle.org/search?term=org.aim42.htmlSanityCheck[web interface]. -==== Prerequisites +== Prerequisites -===== Maven Central (Sonatype) account +=== Maven Central (Sonatype) account Make yourself familiar with https://central.sonatype.org/publish-ea/publish-ea-guide/[the publishing process]. @@ -26,7 +38,7 @@ You will need to https://central.sonatype.org/register/central-portal/#create-an Additionally, you need to create https://central.sonatype.org/publish/generate-portal-token/[a portal token]. [[sec:artifact-signing]] -===== Artifact signing +=== Artifact signing To successfully upload artifacts and other files (POM etc.), a valid PGP signature is required. A proper GPG (agent) setup is beyond the scope of this tutorial. @@ -55,7 +67,7 @@ signing.password= # <3> .Use GPG Agent ==== Alternatively, -you may use the https://linux.die.net/man/1/gpg-agent[GPG Agent] of your https://gnupg.org/[GnuPG] installation +you may use the https://www.gnupg.org/documentation/manuals/gnupg24/gpg-agent.1.html[GPG Agent] of your https://gnupg.org/[GnuPG] installation to cache the secret in memory, thereby reducing the risk of accidentally exposing the clear text passphrase in your command line or environment. @@ -84,13 +96,13 @@ echo empty | gpg --clearsign -o /dev/null ---- ==== -==== Publishing actions +== Publishing actions Adjust version number:: -Set the version number in xref:../../../gradle.properties[] to the next value. +Set the version number in xref:gradle.properties[../../../gradle.properties] to the next value. Maintain ChangeLog:: -Add the respective changes to xref:../../../CHANGELOG.md[] +Add the respective changes to xref:CHANGELOG.{markdown-suffix}[../../../CHANGELOG.md] Build / Test:: Clean, check (test), and perform integration tests: