Skip to content

Commit 9cd76a1

Browse files
authored
Update docs for v3.0.0 release (#779)
* Delete v2.2.x information from CHANGELOG * Clean v3.0.0 changelog * Update README and antora properties
1 parent 41bb44a commit 9cd76a1

File tree

3 files changed

+11
-141
lines changed

3 files changed

+11
-141
lines changed

CHANGELOG.adoc

+4-118
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/main[co
1313

1414
== Unreleased
1515

16+
== v3.0.0 (2024-01-30)
17+
1618
Bug Fixes::
1719

1820
* Fix default value for eruby which caused a fail when using erb templates (#610)
@@ -26,33 +28,22 @@ Improvements::
2628
* Add 'asciidoc' as valid file extension in AsciidoctorDoxiaParserModule (#595)
2729
* Fix throwing an exception when registering a non Extension (#596)
2830
* Reimplement resource copy using 'plexus.util.DirectorScanner' instead of 'maven-filtering' to reduce dependencies and build time (#597)
29-
* Set minimal Maven version to v3.8.5 (#629)
3031
* Replace deprecated 'headerFooter' by 'standalone' in configuration (#649)
31-
* Remove internal use of 'destinationDir' AsciidoctorJ method (no changes for users) (#650)
32-
* Upgrade Asciidoctorj to v2.5.4 and jRuby to v9.3.4.0 (#584)
33-
* Upgrade Asciidoctorj to v2.5.5 (#591)
34-
* Upgrade Asciidoctorj to v2.5.6 and jRuby to v9.3.8.0 (#602)
35-
* Upgrade Asciidoctorj to v2.5.7 (#604)
36-
* Upgrade Asciidoctorj to v2.5.10 and jRuby to v9.4.2.0 (#647)
37-
* Upgrade Asciidoctorj to v2.5.11 (#688)
32+
* Remove internal use of 'destinationDir' AsciidoctorJ method (#650)
33+
* Upgrade Asciidoctorj to v2.5.11 (#688) and jRuby to v9.4.5.0 (#665)
3834
* Improve warning message when destination file is going to be replaced (#728)
3935
* Added `.editorconfig` file to facilitate code formatting (#760)
4036

4137
Build / Infrastructure::
4238

4339
* Fix maven-source-plugin configuration for releases (#644)
4440
* Set Java 11 as minimal version (remove Java8 support) (#652)
45-
* Use Maven v3.9.2 in CI and wrapper (#658)
4641
* Use Maven v3.9.5 in CI and wrapper (#662)
4742
* Add Java 21 to CI (#664)
4843
* Bump Doxia to v1.11.1 and maven-site-plugin in IT to 3.12.0 (#579)
49-
* Bump netty-codec-http to v4.1.77.Final (fix CVE-2021-21290) (#582)
50-
* Bump netty-codec-http to v4.1.87.Final (fix CVE-2022-41915) (#612)
51-
* Bump netty-codec-http to v4.1.89.Final (#615)
5244
* Upgrade build related Maven plugins to the latest versions (#606)
5345
* Set minimal maven version to 3.8.5 (#607)
5446
* Bump GH 'checkout' and 'setup-java' to v3 & delete unused TravisCI configuration (#627)
55-
* Bump netty-codec-http to v4.1.90.Final (#628)
5647
* Bump plugins versions & set CI Maven to v3.9.1 (#629)
5748
* Add Maven matrix testing + define Maven compatibility policy (#632)
5849
* Bump build related Maven plugins to the latest versions (#635)
@@ -67,114 +58,9 @@ Build / Infrastructure::
6758
* Test artifact's signature with Maven in CI (#736)
6859
* Automate release using GH Actions (#141)
6960
* Ensure Mojos use correct default values in unit tests (#609)
70-
71-
Maintenance::
7261
* Replace use of reflection by direct JavaExtensionRegistry calls to register extensions (#596)
7362

7463
Documentation::
7564

7665
* Fix absolute path in usage example and AsciiDoc references in docs (https://github.com/MarkusTiede[@MarkusTiede])(#592)
7766
* Add v3.x.x migration guide (#598)
78-
79-
== v2.2.2 (2022-01-30)
80-
81-
Bug Fixes::
82-
83-
* Exclude dot files and folders from conversion (#550)
84-
* Fix `StringIndexOutOfBoundsException` parsing log records when cursor file is above source directory (#563)
85-
* Fix compatibility with maven-site-plugin v3.10.0 (previous versions no longer supported) (https://github.com/michael-o[@michael-o]) (#566)
86-
87-
Documentation::
88-
89-
* Add ID's for all parameters of process-asciidoc, auto-refresh and http mojo, to be able to generate direct urls (https://github.com/uniqueck[@uniqueck]) (#533)
90-
* Clarify where to put the plugin section in `pom.xml` (#558)
91-
* Add compatibility matrix (#569)
92-
93-
Build / Infrastructure::
94-
95-
* Migrate Maven Wrapper to Apache's offical one (#573)
96-
* Upgrade Asciidoctorj to v2.5.3 and jRuby to v9.2.20.1 (#572)
97-
* Upgrade Asciidoctorj to v2.5.2 (#555)
98-
* Support Java 17 (#557)
99-
* Bump netty-codec-http to v4.1.71.Final (#561)
100-
101-
== v2.2.1 (2021-07-24)
102-
103-
Bug Fixes::
104-
105-
* Fix excluding sources when enclosing parent path starts with _ (#546)
106-
* Treat dot files and folders same as internal #5505)
107-
108-
== v2.2.0 (2021-07-18)
109-
110-
Improvements::
111-
112-
* Allow running a refresh build on included sources (for `auto-refresh` & `http` mojos) (#542)
113-
114-
Documentation::
115-
116-
* Migrate docs (README) to Antora site and publish them in gh-pages (#498)
117-
* Remove ambiguity in usage of maven properties docs (#507)
118-
* Add ID to 'attributes' description, to be able to generate direct url from other docs (#509)
119-
* Fix broken links to extension api documentation (https://github.com/djarnis73[@djarnis73]) (#523)
120-
* Remove local antora site generator stuff (https://github.com/uniqueck[@uniqueck]) (#529)
121-
122-
Build / Infrastructure::
123-
* Upgrade tests to JUnit5 (#521)
124-
* Rename main branch (#524)
125-
* Set maven wrapper to use maven v3.8.1 (#525)
126-
* Upgrade Asciidoctorj to v2.4.3 and jRuby to v9.2.14.0 (#526)
127-
* Upgrade Asciidoctorj to v2.5.0 and jRuby to v9.2.17.0 (#531)
128-
* Upgrade Asciidoctorj to v2.5.1 (#534)
129-
* Added 'Asciidoctor' organization to pom (#539)
130-
* Remove AppVeyor CI build (#540)
131-
* Update `distributionManagement` to deploy directly without Bintray (#544)
132-
133-
Maintenance::
134-
135-
* Upgrade `netty-codec-http` to 4.1.29.Final and refactor `AsciidoctorHttpServer` (#511)
136-
* Rewrite `AsciidoctorMojoTest` to Java to make it more approachable (#512)
137-
* Rewrite `AsciidoctorMojoLogHandlerTest` to Java to make it more approachable (#514)
138-
* Rewrite `AsciidoctorMojoExtensionsTest` to Java to make it more approachable (#515)
139-
* Rewrite `AsciidoctorHttpMojoTest` to Java to make it more approachable (#516)
140-
* Rewrite `AsciidoctorZipMojoTest` to Java to make it more approachable (#518)
141-
* Rewrite `AsciidoctorDoxiaParserTest` to Java + remove Groovy & Spock configurations (#519)
142-
* Replace usage of internal Asciidoctorj `DirectoryWalker` with Java NIO API and fix incorrect sources converted when using `sourceDocumentExtension` (https://github.com/stdll[@stdll]) (#532)
143-
144-
== v2.1.0 (2020-09-15)
145-
146-
Improvements::
147-
148-
* Inject Maven properties as attributes in `process-asciidoc` mojo (#459)
149-
* Make `auto-refresh` (and `http` by inheritance) only convert modified and created sources (#474)
150-
* Make `auto-refresh` only copy modified and created resources + taking into consideration <resources> options (#478)
151-
* Make `auto-refresh` ignore docInfo files to avoid copying them into output (#480)
152-
* Add official support for `http` mojo with life preview and refresh of html output (#483)
153-
154-
Bug Fixes::
155-
156-
* Remove Maven components from plugin descriptor (#450)
157-
* Remove unnecessary maven's @Parameter configuration from ExtensionConfiguration, Synchronization and Resources (#461)
158-
* Remove unused BuildContext from AsciidoctorMojo (#462)
159-
* Remove unnecessary required configuration from mojo parameters (#463)
160-
* Prevent sources from being converted twice in http mojo (#469)
161-
* Remove synchronization property from mojo (#471)
162-
163-
Documentation::
164-
165-
* Add reference to v2-migration-guide in README for better findability (#445)
166-
* Fix broken link to V2 migration guide (https://github.com/ge0ffrey[@ge0ffrey]) (#446)
167-
* Add GitHub's PR and issue templates (#465)
168-
* Add `auto-refresh` mojo documentation (#466)
169-
* Add copyright notice to README and remove unnecessary license header from sources (#482)
170-
171-
Build / Infrastructure::
172-
173-
* Updated maven-release-plugin version (3.0.0-M1) and POM scm configuration to simplify release process
174-
* Adds GitHub Actions build for Linux, Windows, MacOS and Java 8, 11 (#452, #453)
175-
* Simplify TravisCI and AppVeyor to run Java 8 and 11 only (#460)
176-
* Upgrade Maven from v3.5.0 to 3.6.3 in AppVeyor (#460)
177-
* Updated jacoco-maven-plugin version from v0.8.2 to 0.8.5 (#479)
178-
* Use maven-javadoc-plugin version defined in `pluginManagement` + update to v3.2.0 (#481)
179-
* Add Maven Wrapper to project and CI builds (#484)
180-
* Upgrade Asciidoctorj to 2.4.1 and jRuby to 9.2.13.0 (#486)

README.adoc

+6-22
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Asciidoctor Maven Tools (Plugin & Site Integration)
22
// Metadata
3-
:release-version: 2.2.5
4-
:docs-version: 2.2
3+
:release-version: 3.0.0
4+
:docs-version: 3.0
55
:maven-site-plugin-version: 3.12.1
66
// Settings
77
:idprefix:
@@ -59,26 +59,10 @@ ifeval::['{tag}' == 'main']
5959
[NOTE]
6060
====
6161
You're viewing the documentation for the upcoming release.
62-
If you're looking for the documentation for an older release, please refer to one of the following tags: +
63-
{uri-repo}/tree/asciidoctor-maven-plugin-2.2.3#readme[2.2.3]
64-
&hybull;
65-
{uri-repo}/tree/asciidoctor-maven-plugin-2.1.0#readme[2.1.0]
66-
&hybull;
67-
{uri-repo}/tree/asciidoctor-maven-plugin-2.0.0#readme[2.0.0]
68-
&hybull;
69-
{uri-repo}/tree/asciidoctor-maven-plugin-1.6.0#readme[1.6.0]
70-
&hybull;
71-
{uri-repo}/tree/asciidoctor-maven-plugin-1.5.8#readme[1.5.8]
72-
&hybull;
73-
{uri-repo}/tree/asciidoctor-maven-plugin-1.5.7.1#readme[1.5.7.1]
74-
&hybull;
75-
{uri-repo}/tree/asciidoctor-maven-plugin-1.5.6#readme[1.5.6]
76-
&hybull;
77-
{uri-repo}/tree/asciidoctor-maven-plugin-1.5.5#readme[1.5.5]
78-
&hybull;
79-
{uri-repo}/tree/asciidoctor-maven-plugin-1.5.3#readme[1.5.3]
62+
If you're looking for the documentation for an older release, please refer to one of the following tags:
63+
+
64+
{uri-repo}/tree/asciidoctor-maven-plugin-2.2.6#readme[2.2.6]
8065
&hybull;
81-
{uri-repo}/tree/asciidoctor-maven-plugin-1.5.2.1#readme[1.5.2.1]
8266
====
8367
endif::[]
8468

@@ -138,7 +122,7 @@ The {uri-docs}/project/contributing.html[Contributor Guide] will help you start
138122

139123
== Copyright and License
140124

141-
Copyright (C) 2013-2020 Jason Porter, Dan Allen, Abel Salgado Romero and the individual contributors.
125+
Copyright (C) 2013-2024 Jason Porter, Dan Allen, Abel Salgado Romero and the individual contributors.
142126
Use of this software is granted under the terms of the Apache License, Version 2.0.
143127

144128
See the {uri-license}[LICENSE] for the full license text.

docs/antora.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ asciidoc:
1111
uri-examples: https://github.com/asciidoctor/asciidoctor-maven-examples
1212
uri-maven: https://maven.apache.org
1313
uri-maven-site-plugin: https://maven.apache.org/plugins/maven-site-plugin
14-
maven-site-plugin-version: 3.12.0
14+
maven-site-plugin-version: 3.12.1
1515
nav:
1616
- modules/plugin/nav.adoc
1717
- modules/site-integration/nav.adoc

0 commit comments

Comments
 (0)