This is an automated email from the ASF dual-hosted git repository. pottlinger pushed a commit to branch feature/RAT-504 in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
commit 3435abb48885c54fac046c77a6748bc340ad4786 Author: P. Ottlinger <[email protected]> AuthorDate: Mon Oct 27 22:40:07 2025 +0100 RAT-504: Provide page skeleton for migration guides --- apache-rat/src/site/apt/output/example.apt | 4 ++-- apache-rat/src/site/markdown/migration_guide.md | 25 ++++++++++++++++++++++ .../src/site/markdown/migrationguide/0.17.md | 20 +++++++++++++++++ .../src/site/markdown/migrationguide/1.0.0.md | 20 +++++++++++++++++ src/changes/changes.xml | 3 +++ src/site/site.xml | 3 ++- 6 files changed, 72 insertions(+), 3 deletions(-) diff --git a/apache-rat/src/site/apt/output/example.apt b/apache-rat/src/site/apt/output/example.apt index cb34b703..9ef4a3ae 100644 --- a/apache-rat/src/site/apt/output/example.apt +++ b/apache-rat/src/site/apt/output/example.apt @@ -21,8 +21,8 @@ Default Output Example - By default Rat produces a plain text output that is the result of processing the XML output with the plain text style - sheet. The output is designed to provide the most commonly requested data. Additional data may be retrieved by using + By default RAT produces a plain text output that is the result of processing the XML output with the plain text style + sheet. The output is designed to provide the most commonly requested data. Additional data may be retrieved by using custom style sheets. +------------------------------------------+ diff --git a/apache-rat/src/site/markdown/migration_guide.md b/apache-rat/src/site/markdown/migration_guide.md new file mode 100644 index 00000000..ee546bb0 --- /dev/null +++ b/apache-rat/src/site/markdown/migration_guide.md @@ -0,0 +1,25 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Creadur RAT Migration Guide + +As each RAT release introduce new functionality its configuration needs to be changed as well. + +The subpages listed here help you to make the most out of the corresponding version of RAT: + +* [0.17](./migrationguide/0.17.html) +* [1.0.0](./migrationguide/1.0.0.html) \ No newline at end of file diff --git a/apache-rat/src/site/markdown/migrationguide/0.17.md b/apache-rat/src/site/markdown/migrationguide/0.17.md new file mode 100644 index 00000000..e888244a --- /dev/null +++ b/apache-rat/src/site/markdown/migrationguide/0.17.md @@ -0,0 +1,20 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Creadur RAT Migration Guide - Release 0.17 + +tbd \ No newline at end of file diff --git a/apache-rat/src/site/markdown/migrationguide/1.0.0.md b/apache-rat/src/site/markdown/migrationguide/1.0.0.md new file mode 100644 index 00000000..de7b2153 --- /dev/null +++ b/apache-rat/src/site/markdown/migrationguide/1.0.0.md @@ -0,0 +1,20 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Creadur RAT Migration Guide - Release 1.0.0 + +tbd \ No newline at end of file diff --git a/src/changes/changes.xml b/src/changes/changes.xml index f578d2ff..53b13f62 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -68,6 +68,9 @@ in order to be properly linked in site reports. </release> --> <release version="1.0.0" date="xxxx-yy-zz" description="Current SNAPSHOT - release to be done"> + <action issue="RAT-504" type="add" dev="pottlinger"> + Provide a migration guide to specific RAT versions for downstream users. + </action> <action issue="RAT-500" type="fix" dev="pottlinger"> Do not throw an exception if no arguments are provided in CLI, encourage to use --help instead. </action> diff --git a/src/site/site.xml b/src/site/site.xml index 4e9011b3..f81b87ad 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -49,7 +49,8 @@ <item name="Introducing RAT" href="/index.html"/> <item name="Downloads" href="/download_rat.cgi"/> <item name="Changes" href="/changes.html"/> - <item name="Known issues" href="apache-rat/known_issues.html"/> + <item name="Known Issues" href="apache-rat/known_issues.html"/> + <item name="Migration Guide" href="apache-rat/migration_guide.html"/> </menu> <menu name="RAT from the Command Line" inherit="bottom"> <item name="Command Line Introduction" href="apache-rat/index.html"/>
