You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/06 17:26:37 UTC
(maven-file-management) branch master updated (b7e4a0f -> 22c24c2)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-file-management.git
from b7e4a0f Bump apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml
new f9a3893 Rename the site documents ahead of converting them
new 22c24c2 Port the site documentation from APT to Markdown
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/site/apt/index.apt.vm | 46 -----------
.../mojo.apt.vm => markdown/examples/mojo.md.vm} | 92 ++++++++++------------
src/site/markdown/index.md | 31 ++++++++
3 files changed, 74 insertions(+), 95 deletions(-)
delete mode 100644 src/site/apt/index.apt.vm
rename src/site/{apt/examples/mojo.apt.vm => markdown/examples/mojo.md.vm} (57%)
create mode 100644 src/site/markdown/index.md
(maven-file-management) 02/02: Port the site documentation from APT to Markdown
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-file-management.git
commit 22c24c28a320c39c50b53f0279a05d0906029619
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:02 2026 +0200
Port the site documentation from APT to Markdown
3 page(s) converted with doxia-converter and then cleaned up by hand:
- <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
becomes [text](url)
- the ASF license header becomes a single block HTML comment
- a page whose only Velocity reference was ${project.name} is now a plain
.md with the title spelled out
- a page that keeps a reference stays a .vm. Velocity reads ## as a line
comment and would silently swallow every ATX heading below level one, so
subsections use setext underlines and anything deeper is wrapped in
#[[ ... ]]#
- references APT rendered literally are escaped, so they do not resolve
Verified by building the site before and after and comparing every
generated page: the visible text and the link targets are unchanged apart
from <b>/<i> becoming <strong>/<em> and quotes in prose picking up the
Markdown module's typographic substitution.
---
src/site/markdown/examples/mojo.md.vm | 92 ++++++++++++++++-------------------
src/site/markdown/index.md | 77 ++++++++++++-----------------
2 files changed, 74 insertions(+), 95 deletions(-)
diff --git a/src/site/markdown/examples/mojo.md.vm b/src/site/markdown/examples/mojo.md.vm
index 1e3ae22..388ce1e 100644
--- a/src/site/markdown/examples/mojo.md.vm
+++ b/src/site/markdown/examples/mojo.md.vm
@@ -1,40 +1,32 @@
- ------
- Using Maven File Management API In A MOJO
- ------
- Vincent Siveton
- ------
- November 2007
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-Using Maven File Management API In A MOJO
-
- This part explains how to use the Maven File Management API in a Maven Plugin.
-
-* Add File Management API dependency
-
- The first step is to add the File Management API as a Maven dependency, i.e. in the <<<pom.xml>>>:
-
-+-----+
+<!--
+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.
+-->
+
+# Using Maven File Management API In A MOJO
+
+This part explains how to use the Maven File Management API in a Maven Plugin.
+
+Add File Management API dependency
+----------------------------------
+
+The first step is to add the File Management API as a Maven dependency, i.e. in the `pom.xml`:
+
+```xml
<project>
...
<dependencies>
@@ -47,13 +39,14 @@ Using Maven File Management API In A MOJO
</dependencies>
...
</project>
-+-----+
+```
-* Add FileSet in a MOJO
+Add FileSet in a MOJO
+---------------------
- The second step is to create your MOJO and add a <<<FileSet>>> object:
+The second step is to create your MOJO and add a `FileSet` object:
-+-----+
+```unknown
/**
* My MOJO
*/
@@ -74,11 +67,11 @@ public class MyMojo extends AbstractMojo {
...
}
-+-----+
+```
- To use the <<<FileSet>>> object, you need to instantiate the <<<FileSetManager>>>.
+To use the `FileSet` object, you need to instantiate the `FileSetManager`.
-+-----+
+```unknown
FileSetManager fileSetManager = new FileSetManager();
String[] includedFiles = fileSetManager.getIncludedFiles( fileset );
@@ -86,13 +79,14 @@ String[] includedDir = fileSetManager.getIncludedDirectories( fileset );
String[] excludedFiles = fileSetManager.getExcludedFiles( fileset );
String[] excludedDir = fileSetManager.getExcludedDirectories( fileset );
fileSetManager.delete( fileset );
-+-----+
+```
-* Configure your Maven Plugin
+Configure your Maven Plugin
+---------------------------
- The last step is the Maven Plugin configuration.
+The last step is the Maven Plugin configuration.
-+-----+
+```xml
<project>
...
<build>
@@ -136,4 +130,4 @@ fileSetManager.delete( fileset );
</build>
...
</project>
-+-----+
+```
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index d387961..a6e7a55 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,46 +1,31 @@
- ------
- Introduction
- ------
- Vincent Siveton
- ------
- 2013-07-23
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-${project.name}
-
- The Maven File Management API provides an API to collect files from a given directory using
- several include/exclude rules.
-
-* Brief History
-
- This original code is based on the <<<org.apache.tools.ant.util>>> package from the {{{http://ant.apache.org/}Ant}}
- build tool.
-
-* Examples
-
- To provide you with better understanding on some usages of this API,
- you can take a look into the following examples:
-
- * {{{./examples/mojo.html}Using the API in a Maven Plugin}}
-
- []
+<!--
+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.
+-->
+
+# Apache Maven File Management API
+The Maven File Management API provides an API to collect files from a given directory using several include/exclude rules.
+
+## Brief History
+
+This original code is based on the `org.apache.tools.ant.util` package from the [Ant](http://ant.apache.org/) build tool.
+
+## Examples
+
+To provide you with better understanding on some usages of this API, you can take a look into the following examples:
+
+- [Using the API in a Maven Plugin](./examples/mojo.html)
(maven-file-management) 01/02: Rename the site documents ahead of converting them
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-file-management.git
commit f9a389373c8fb623ee6fc86c7daa39e62c73166b
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 13:53:02 2026 +0200
Rename the site documents ahead of converting them
A pure rename, so that git records it and `git log --follow` and `git blame` still
reach the history of each page after the conversion that follows. The content is
still APT at this point and the site does not build between the two commits.
---
src/site/{apt/examples/mojo.apt.vm => markdown/examples/mojo.md.vm} | 0
src/site/{apt/index.apt.vm => markdown/index.md} | 0
2 files changed, 0 insertions(+), 0 deletions(-)
diff --git a/src/site/apt/examples/mojo.apt.vm b/src/site/markdown/examples/mojo.md.vm
similarity index 100%
rename from src/site/apt/examples/mojo.apt.vm
rename to src/site/markdown/examples/mojo.md.vm
diff --git a/src/site/apt/index.apt.vm b/src/site/markdown/index.md
similarity index 100%
rename from src/site/apt/index.apt.vm
rename to src/site/markdown/index.md