Skip to content

Commit

Permalink
Merge pull request #8898 from eclipse/fix/jetty-10-home-with-docs
Browse files Browse the repository at this point in the history 
Issue #8895 - Introduce `jetty-home-<ver>-with-docs.zip`
  • Loading branch information
@joakime
joakime authored Nov 17, 2022
2 parents 55e9f73 + d2c1b1c commit 8de1bad
Show file tree
Hide file tree
Showing 26 changed files with 330 additions and 153 deletions.
2 changes: 1 addition & 1 deletion demos/demo-proxy-webapp/src/main/webapp/WEB-INF/web.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<servlet-class>org.eclipse.jetty.proxy.ProxyServlet$Transparent</servlet-class>
<init-param>
<param-name>proxyTo</param-name>
<param-value>https://www.eclipse.org/jetty/javadoc/jetty-11/index.html?overview-summary.html</param-value>
<param-value>https://www.eclipse.org/jetty/javadoc/jetty-10/index.html?overview-summary.html</param-value>
</init-param>
<init-param>
<param-name>hostHeader</param-name>
Expand Down
3 changes: 2 additions & 1 deletion documentation/jetty-asciidoctor-extensions/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@
</dependency>
<dependency>
<groupId>org.eclipse.jetty.tests</groupId>
<artifactId>test-distribution</artifactId>
<artifactId>jetty-home-tester</artifactId>
<scope>compile</scope>
</dependency>
</dependencies>
</project>
2 changes: 1 addition & 1 deletion ...ty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/JettyIncludeExtension.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import org.asciidoctor.extension.IncludeProcessor;
import org.asciidoctor.extension.PreprocessorReader;
import org.asciidoctor.jruby.extension.spi.ExtensionRegistry;
import org.eclipse.jetty.tests.distribution.JettyHomeTester;
import org.eclipse.jetty.tests.hometester.JettyHomeTester;

/**
* <p>Asciidoctor <em>include</em> extension that includes into
Expand Down
27 changes: 3 additions & 24 deletions javadoc/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@
infinispan-embedded,
infinispan-remote,
jetty-test-helper,
jetty-maven-plugin,
jetty-jspc-maven-plugin,
alpn-api,
quic-quiche,
quic-quiche-common,
Expand Down Expand Up @@ -126,7 +128,7 @@
<id>build-javadoc</id>
<phase>prepare-package</phase>
<goals>
<goal>javadoc</goal>
<goal>jar</goal>
</goals>
<configuration>
<doctitle>Eclipse Jetty API Doc - v${project.version}</doctitle>
Expand Down Expand Up @@ -379,29 +381,6 @@
</exclusion>
</exclusions>
</dependency>
<!-- === Maven Plugin Deps == -->
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-jspc-maven-plugin</artifactId>
<scope>provided</scope>
<exclusions>
<exclusion>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-maven-plugin</artifactId>
<scope>provided</scope>
</dependency>
<!-- to make maven plugins source sane -->
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<scope>provided</scope>
</dependency>
<!-- === InfiniSpan Deps === -->
<dependency>
<groupId>org.eclipse.jetty</groupId>
Expand Down
70 changes: 69 additions & 1 deletion jetty-home/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<properties>
<assembly-directory>${basedir}/target/jetty-home</assembly-directory>
<source-assembly-directory>${basedir}/target/jetty-home-sources</source-assembly-directory>
<docs-assembly-directory>${basedir}/target/jetty-home-with-docs</docs-assembly-directory>
<jetty-setuid-version>1.0.4</jetty-setuid-version>
<spotbugs.skip>true</spotbugs.skip>
</properties>
Expand Down Expand Up @@ -49,6 +50,7 @@
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
Expand Down Expand Up @@ -120,7 +122,6 @@
</artifactItems>
</configuration>
</execution>

<execution>
<id>copy-lib-deps</id>
<phase>generate-resources</phase>
Expand Down Expand Up @@ -508,6 +509,44 @@
<outputDirectory>${assembly-directory}</outputDirectory>
</configuration>
</execution>
<execution>
<id>unpack-documentation</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>org.eclipse.jetty.documentation</groupId>
<artifactId>jetty-documentation</artifactId>
<version>${project.version}</version>
<classifier>html</classifier>
<type>zip</type>
</artifactItem>
</artifactItems>
<outputDirectory>${docs-assembly-directory}/docs</outputDirectory>
</configuration>
</execution>
<execution>
<id>unpack-javadoc-aggregate</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>org.eclipse.jetty</groupId>
<artifactId>javadoc</artifactId>
<version>${project.version}</version>
<classifier>javadoc</classifier>
<type>jar</type>
</artifactItem>
</artifactItems>
<outputDirectory>${docs-assembly-directory}/javadoc</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
Expand Down Expand Up @@ -563,6 +602,19 @@
<appendAssemblyId>true</appendAssemblyId>
</configuration>
</execution>
<execution>
<id>docs</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<descriptors>
<descriptor>src/main/assembly/jetty-with-docs-assembly.xml</descriptor>
</descriptors>
<appendAssemblyId>true</appendAssemblyId>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
Expand Down Expand Up @@ -876,6 +928,22 @@
<type>jar</type>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.eclipse.jetty.documentation</groupId>
<artifactId>jetty-documentation</artifactId>
<version>${project.version}</version>
<classifier>html</classifier>
<type>zip</type>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>javadoc</artifactId>
<version>${project.version}</version>
<classifier>javadoc</classifier>
<type>jar</type>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
Expand Down
46 changes: 46 additions & 0 deletions jetty-home/src/main/assembly/jetty-with-docs-assembly.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<assembly>
<id>with-docs</id>
<formats>
<format>tar.gz</format>
<format>zip</format>
</formats>
<fileSets>
<fileSet>
<directory>${assembly-directory}</directory>
<outputDirectory></outputDirectory>
<includes>
<include>**</include>
</includes>
<excludes>
<exclude>**/META-INF/**</exclude>
<exclude>*-config.jar</exclude>
<!-- we'll build up shell scripts with execute in separate file-set -->
<exclude>bin/*.sh</exclude>
</excludes>
<!-- The archive is generated with the uid / gid of the user that
built the jetty release. which is highly unlikely to
exist on the target machines that unpack this tarball.
We set the user / group / other to have read-only access
to files, and read-execute access to directories
in the unpacked contents. -->
<fileMode>0444</fileMode>
<directoryMode>0755</directoryMode>
</fileSet>
<fileSet>
<directory>${assembly-directory}</directory>
<outputDirectory></outputDirectory>
<includes>
<include>bin/*.sh</include>
</includes>
<!-- Set read-execute for shell scripts -->
<fileMode>0555</fileMode>
</fileSet>
<fileSet>
<directory>${docs-assembly-directory}</directory>
<outputDirectory></outputDirectory>
<includes>
<include>**</include>
</includes>
</fileSet>
</fileSets>
</assembly>
11 changes: 8 additions & 3 deletions jetty-home/src/main/resources/modules/demo.d/root/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,15 @@ <h2>demos</h2>
<h2>information</h2>
<ul>
<li><a href="https://www.eclipse.org/jetty/">Jetty Homepage</a></li>
<li><a href="https://www.eclipse.org/jetty/documentation/current">Jetty Documentation</a></li>
<li><a href="https://www.eclipse.org/jetty/documentation/">Jetty Documentation Hub</a></li>
<li><a href="/proxy/current/">Javadoc</a> (via transparent proxy)</li>
<li><a
href="https://www.eclipse.org/jetty/powered">Jetty Powered</a></li>
<li><a href="https://www.eclipse.org/jetty/powered">Jetty Powered</a></li>
<li>Optional content found only in<br><code>jetty-home-&lt;ver&gt;-with-docs.zip</code>
<ul>
<li><a href="/docs/">Jetty Documentation</a></li>
<li><a href="/javadoc/">Javadoc</a></li>
</ul>
</li>
</ul>
</td>
<td>
Expand Down
28 changes: 23 additions & 5 deletions jetty-home/src/main/resources/modules/demo.d/root/jetty.css
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
BODY
body
{
font-family: Arial, Verdana, Helvetica, sans-serif;
background-color: #FFFFFF;
font-family: sans-serif;
background-color: white;
font-size: 14pt;
color: #444444;
}

code
{
font-family: monospace;
}

img
{
border: 0px;
}


div#header
{
clear: both;
Expand All @@ -26,7 +30,6 @@ div#header
margin-right: auto;
}


div#content
{
clear: both;
Expand Down Expand Up @@ -75,6 +78,21 @@ div#links h1,h2,p
margin: 5px;
}

div#links ul
{
padding-left: 20px;
}

div#links li
{
font-size: 10pt;
}

div#links code
{
font-size: 9pt;
}

div#links h2
{
font-size: 12pt;
Expand Down
1 change: 1 addition & 0 deletions jetty-maven-plugin/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,7 @@
<artifactId>jetty-home</artifactId>
<scope>test</scope>
<type>zip</type>
<optional>true</optional>
<exclusions>
<!-- eliminating dependencies of jetty-home that are being pulled in when in reactor
for the jetty build itself. This can cause accidental cyclic references. -->
Expand Down
10 changes: 7 additions & 3 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,7 @@
<module>documentation</module>
<module>jetty-keystore</module>
<module>jetty-unixdomain-server</module>
<module>javadoc</module>
</modules>

<build>
Expand Down Expand Up @@ -1339,6 +1340,12 @@
<version>${project.version}</version>
<type>zip</type>
</dependency>
<dependency>
<groupId>org.eclipse.jetty.tests</groupId>
<artifactId>jetty-home-tester</artifactId>
<version>${project.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-http</artifactId>
Expand Down Expand Up @@ -2206,9 +2213,6 @@
</profile>
<profile>
<id>eclipse-release</id>
<modules>
<module>javadoc</module>
</modules>
<build>
<plugins>
<plugin>
Expand Down
Loading

0 comments on commit 8de1bad

Please sign in to comment.