Skip to content

Generating configuration documentation during site build#10961

Merged
slawekjaranowski merged 2 commits intoapache:masterfrom
slawekjaranowski:gen-config-site
Jul 21, 2025
Merged

Generating configuration documentation during site build#10961
slawekjaranowski merged 2 commits intoapache:masterfrom
slawekjaranowski:gen-config-site

Conversation

@slawekjaranowski
Copy link
Member

No description provided.

<phase>pre-site</phase>
<configuration>
<target>
<!-- directory should be created by org.eclipse.aether.tools.CollectConfiguration -->
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be fixed in CollectConfiguration

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that "should already be fixed In CollectConfiguration" or "we need to fix that in CollectConfiguration" ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be, I will prepare PR

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this file was not included in site .... what is for?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also this file was not included in site .... what is for?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the idea was to publish them somehow, so that they can be consumed programmatically, not only from docs. But there's no real usage yet, so removing them is fine for now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, now configuration.properties and configuration.yaml are not published because are in markdown directory ...
to publish it we need put it in site/resources

I will add a comments for it

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a separate execution for properties files

@slawekjaranowski slawekjaranowski marked this pull request as ready for review July 21, 2025 16:38
@slawekjaranowski slawekjaranowski requested a review from gnodet July 21, 2025 16:40
@slawekjaranowski slawekjaranowski merged commit 93d231d into apache:master Jul 21, 2025
19 checks passed
@slawekjaranowski slawekjaranowski deleted the gen-config-site branch July 21, 2025 18:49
@github-actions github-actions bot added this to the 4.1.0 milestone Jul 21, 2025
gnodet added a commit to gnodet/maven that referenced this pull request Jul 21, 2025
Resolved conflicts by accepting deletion of documentation files that were
moved/reorganized in master:
- src/site/markdown/configuration.properties
- src/site/markdown/configuration.yaml
- src/site/markdown/maven-configuration.md

These files were moved to src/configuration-templates/ in master.

Merged changes include:
- Fix doap_Maven.rdf
- Add PathMatcherFactory.includesAll() (apache#10964)
- Generating configuration documentation during site build (apache#10961)
- Use correct namespace in settings.xml (apache#10974)
- Make error message less awkward (apache#10953)

All plugin migration changes preserved and compatible with latest master.
gnodet pushed a commit to gnodet/maven that referenced this pull request Jul 24, 2025
* Generating configuration documentation during site build

* next execution for configuration properties
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants