Skip to content

Fixes #5687 : Generate the configuration perspective option tables fr… #8706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattcasters merged 2 commits into from
Oct 1, 2026
Merged

Fixes #5687 : Generate the configuration perspective option tables fr… #8706

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15b978b
Issue #5687 : Generate the configuration perspective option tables fr…
bamaer Sep 29, 2026
bee5fb7
Issue #5687 : Address review comments
bamaer Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/pr_build_code.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,28 @@ jobs:
run: mvn spotless:check -Dgib.disable=$GIB_DISABLE -Dgib.buildUpstream=false
- name: Build with Maven
run: MAVEN_OPTS="-XX:+TieredCompilation -XX:TieredStopAtLevel=1"; mvn clean install -T 1C -B -C -e -fae -V -Dmaven.compiler.fork=true -Dsurefire.rerunFailingTestsCount=2 -Dassemblies=false -Dmodule.zips=false -Djacoco.skip=true -Dgib.disable=$GIB_DISABLE --file pom.xml
# The build regenerates the configuration perspective's option tables from the
# @ConfigPlugin and @GuiWidgetElement annotations. If that leaves the working tree
# dirty, the committed page no longer matches the code it documents.
- name: Configuration documentation is up to date
run: |
CONFIG_DOCS=docs/hop-user-manual/modules/ROOT/partials/config
# --porcelain, not diff: a newly added configuration plugin writes a new .adoc, and an
# untracked file is invisible to git diff.
if [ -n "$(git status --porcelain -- $CONFIG_DOCS)" ]; then
echo "The configuration perspective's generated option tables are out of date."
echo "A configuration option was added, removed or changed without regenerating"
echo "the page that documents it."
echo
echo "To fix, from a full build of your branch:"
echo " mvn clean install -DskipTests"
echo "and commit the result under $CONFIG_DOCS."
echo
git status --short -- $CONFIG_DOCS
git diff -- $CONFIG_DOCS
exit 1
fi
echo "Generated configuration documentation matches the code."

# Add a UI and run the UI tests only
ui-tests:
Expand Down
208 changes: 208 additions & 0 deletions config-doc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ 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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache.hop</groupId>
<artifactId>hop</artifactId>
<version>2.20.0-SNAPSHOT</version>
</parent>

<artifactId>hop-config-doc</artifactId>
<packaging>jar</packaging>
<name>Hop Configuration Documentation Generator</name>
<description>Regenerates the AsciiDoc tables describing the options in the configuration perspective.
A build tool: it is not part of any assembly and ships with nothing.</description>

<properties>
<docs.partials.directory>${project.basedir}/../docs/hop-user-manual/modules/ROOT/partials/config</docs.partials.directory>
</properties>

<dependencies>
<dependency>
<groupId>io.smallrye</groupId>
<artifactId>jandex</artifactId>
<version>${jandex.version}</version>
</dependency>

<!-- The hop-* dependencies below are not used in code. They are the modules that declare a
@ConfigPlugin, and they are here so the reactor builds this one after all of them: the
generator reads the whole tree's build output, so running it earlier would document a
previous build. Declaration order alone would not hold under a parallel (-T) build; a
dependency edge does. A module that starts declaring a @ConfigPlugin belongs in this
list; until it is added its options simply appear on the next build. -->
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-misc-git</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-misc-lint</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-misc-projects</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-tech-ai</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-tech-azure</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-tech-calcite</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-tech-dropbox</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-tech-google</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.hop</groupId>
<artifactId>hop-ui</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<exclusions>
<!-- The edge is all that is wanted here, not the classpath behind it. -->
<exclusion>
<groupId>*</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.5.0</version>
<executions>
<execution>
<id>generate-config-docs</id>
<goals>
<!-- exec, not java: the java goal runs inside Maven's own JVM, where
java.class.path is Maven's classpath rather than this module's.
The generator reads its classpath to find the modules to
document, so it needs a forked JVM with the real one. -->
<goal>exec</goal>
</goals>
<phase>package</phase>
<configuration>
<!-- The JVM running the build, not whatever java is first on
PATH: this module's classes are compiled for the former, and an
older PATH java fails here with an UnsupportedClassVersionError
from, of all things, a documentation generator. -->
<executable>${java.home}/bin/java</executable>
<!-- The modules to document are provided-scope dependencies, which
the default runtime classpath leaves out. -->
<classpathScope>compile</classpathScope>
<arguments>
<argument>-classpath</argument>
<classpath></classpath>
<argument>org.apache.hop.config.doc.ConfigDocGenerator</argument>
<argument>${project.basedir}/..</argument>
<argument>${docs.partials.directory}</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Loading
Loading