Allow to set an alternative source directory (for editing) by kwin · Pull Request #625 · apache/maven-doxia-sitetools

kwin · 2026-03-11T13:46:46Z

Always check if a file is existing before returning true for isEditable and non-null for getDoxiaSourcePath()/getDoxiaSourcePath(String)

This closes #277

Following this checklist to help us incorporate your
contribution quickly and easily:

Your pull request should address just one issue, without pulling in other changes.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Each commit in the pull request should have a meaningful subject line and body.
Note that commits might be squashed by a maintainer on merge.
Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
Run mvn verify to make sure basic checks pass.
A more thorough check will be performed on your pull request automatically.
You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.

kwin · 2026-03-11T14:41:27Z

Usage in m-site-p in apache/maven-site-plugin#1239.

doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/RenderingContextTest.java

michael-o · 2026-03-16T16:51:58Z

This is quite some change. Will take a bit to review.

Always check if a file is existing before returning true for isEditable and non-null for getDoxiaSourcePath()/getDoxiaSourcePath(String) This closes #277

michael-o · 2026-03-22T14:03:57Z

doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/RenderingContextTest.java

-        assertEquals("path/file.html", docRenderingContext.getOutputPath());
-        assertEquals("..", docRenderingContext.getRelativePath());
-    }
-}


This should have been a "git mv" instead of deletion and addtion, no?

Look at https://archive.kernel.org/oldwiki/git.wiki.kernel.org/index.php/GitFaq.html#Why_does_Git_not_.22track.22_renames.3F. Wouldn't make a difference in the diff.

michael-o · 2026-03-22T14:05:13Z

doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java

         *
-         * @param path
-         * @param editable
+         * @param path absolute path to the site directory containing doxia sources files, expected to have a Doxia Site layout, i.e. one directory per Doxia parser module


Doxia source files

Fixed in 1efd3e8.

michael-o · 2026-03-22T14:05:33Z

doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java

         *
-         * @param path
-         * @param editable
+         * @param path absolute path to the site directory containing doxia sources files, expected to have a Doxia Site layout, i.e. one directory per Doxia parser module


You say absolute path, but we don't enforce it...?

Yes, removed "absolute" in 1efd3e8.

michael-o · 2026-03-22T14:06:52Z

doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java

+            if (editableSourceDirectories.isEmpty()) {
+                return Collections.singleton(path);
+            } else {
+                return editableSourceDirectories;


This should return only a view, no?

Yes, fixed in 1efd3e8.

doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java

michael-o · 2026-03-22T14:09:07Z

doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java

    private void addModuleFiles(
-            File rootDir,
+            File siteRootDirectory,
+            SiteDirectory siteDirectory,


If we have a site root directory, why is path the absolute for site directory?

I don't get this question, but siteRootDirectory is pointing to the ${basedir} while siteDirectory is usually ${basedir}/src/site.

michael-o · 2026-03-22T14:10:56Z

...ite-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java

+    /** The project's build directory, may be {@code null} rendered from a Doxia source) */
+    private final File rootDirectory;
+
+    /** The site's root directory (never null), must be within below {@link #rootDirectory}, may be {@code null} rendered from a Doxia source */


Contradiction. It first says never null, then it maybe null

Right, may in fact be null. Fixed in 1efd3e8.

...ite-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java

michael-o · 2026-03-22T14:12:57Z

...ite-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java


    /**
-     * Get the relative path to site root.
+     * Get the relative path of the parent folder to site root.


parent directory

Fixed in 1efd3e8.

michael-o

No objections...

github-actions · 2026-03-28T09:25:48Z

@kwin Please assign appropriate label to PR according to the type of change.

kwin requested review from hboutemy and michael-o March 11, 2026 13:46

kwin mentioned this pull request Mar 11, 2026

Allow to give alternative source directories for sites apache/maven-site-plugin#1239

Draft

8 tasks

kwin commented Mar 11, 2026

View reviewed changes

doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/RenderingContextTest.java Outdated Show resolved Hide resolved

kwin force-pushed the feature/overwrite-source-directory branch 3 times, most recently from 43adea5 to 3a6151e Compare March 16, 2026 16:51

Allow to set an alternative source directory (for editing)

b4e6c73

Always check if a file is existing before returning true for isEditable and non-null for getDoxiaSourcePath()/getDoxiaSourcePath(String) This closes #277

kwin force-pushed the feature/overwrite-source-directory branch from 3a6151e to b4e6c73 Compare March 16, 2026 17:08

michael-o requested changes Mar 22, 2026

View reviewed changes

kwin requested a review from michael-o March 27, 2026 17:11

michael-o approved these changes Mar 27, 2026

View reviewed changes

Fixed PR comments

66067af

kwin force-pushed the feature/overwrite-source-directory branch from 1efd3e8 to 66067af Compare March 28, 2026 09:21

kwin merged commit 081a0e8 into master Mar 28, 2026
15 checks passed

kwin deleted the feature/overwrite-source-directory branch March 28, 2026 09:25

github-actions bot added this to the 2.1.0 milestone Mar 28, 2026

github-actions bot assigned kwin Mar 28, 2026

kwin added the enhancement New feature or request label Mar 28, 2026

Conversation

kwin commented Mar 11, 2026

Uh oh!

kwin commented Mar 11, 2026

Uh oh!

Uh oh!

michael-o commented Mar 16, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michael-o left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Mar 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants