Download page template #218
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| <?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.maven</groupId> | ||
| <artifactId>maven-parent</artifactId> | ||
| <version>44-SNAPSHOT</version> | ||
| </parent> | ||
|
|
||
| <artifactId>maven-shared-doc-resource</artifactId> | ||
|
Member
There was a problem hiding this comment. I would rather name this maven-shared-site-resource as the files in it are pretty maven-site specific.
Member
Author
There was a problem hiding this comment. still is a question - should such template be placed in this project or some other? |
||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-remote-resources-plugin</artifactId> | ||
| <configuration> | ||
| <includes> | ||
| <include>**/*.vm</include> | ||
| <include>**/*.cgi</include> | ||
| </includes> | ||
| </configuration> | ||
| <executions> | ||
| <execution> | ||
| <goals> | ||
| <goal>bundle</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: Download ${project.name} Source | ||
| --- | ||
| #* | ||
| 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. | ||
| *# | ||
| #set( $h = "#" ) | ||
| #set( $downloadDirectory = $project.properties.downloadDirectory ) | ||
|
Member
There was a problem hiding this comment. we need some documentation of the properties used by this template.
Member
Author
There was a problem hiding this comment. when we make decision where we should put it we will add a documentation |
||
| #if( ! $downloadDirectory ) | ||
| #set( $downloadDirectory = "plugins" ) | ||
| #end | ||
| #set( $downloadArtifactId = $project.properties.downloadArtifactId ) | ||
| #if( ! $downloadArtifactId ) | ||
| #set( $downloadArtifactId = $project.artifactId ) | ||
| #end | ||
|
|
||
| # Download ${project.name} ${project.version} Source | ||
|
|
||
| ${project.name} ${project.version} is distributed in source format. Use a source archive if you intend to build | ||
| ${project.name} yourself. Otherwise, simply use the ready-made binary artifacts from central repository. | ||
|
|
||
| In order to guard against corrupted downloads/installations, it is highly recommended to | ||
| [verify the signature](https://www.apache.org/dev/release-signing#verifying-signature) | ||
| of the release bundles against the public [KEYS](https://downloads.apache.org/maven/KEYS) used by the Apache Maven | ||
| developers. | ||
|
|
||
| ${project.name} is distributed under the [Apache License, version 2.0](https://www.apache.org/licenses/). | ||
|
|
||
| ${h}${h} ${project.name} ${project.version} | ||
|
|
||
| This is the current stable version of ${project.name}. | ||
|
|
||
| | | Link |Checksum|Signature| | ||
| |---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---| | ||
| ${project.name} ${project.version} (Source zip)| [${downloadArtifactId}-${project.version}-source-release.zip](https://www.apache.org/dyn/closer.lua/maven/${downloadDirectory}/${downloadArtifactId}-${project.version}-source-release.zip?action=download) |[${downloadArtifactId}-${project.version}-source-release.zip.sha512](https://downloads.apache.org/maven/${downloadDirectory}/${downloadArtifactId}-${project.version}-source-release.zip.sha512)|[${downloadArtifactId}-${project.version}-source-release.zip.asc](https://downloads.apache.org/maven/${downloadDirectory}/${downloadArtifactId}-${project.version}-source-release.zip.asc)| | ||
|
|
||
| ${h}${h} Previous Versions | ||
|
|
||
| Older non-recommended releases can be found on our [archive site](https://archive.apache.org/dist/maven/${downloadDirectory}/). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -914,6 +914,7 @@ under the License. | |
| <module>maven-skins</module> | ||
| <module>doxia-tools</module> | ||
| <module>docs</module> | ||
| <module>maven-shared-doc-resource</module> | ||
|
Member
There was a problem hiding this comment. I will try to work on MSITE-911 in the near future, so this doesn't need to be maintained outside the parent project.
Member
Author
There was a problem hiding this comment. My approach to put it in external repo are:
Member
There was a problem hiding this comment. Hello @slawekjaranowski The Commons Build and Release plugins are not deprecated and generates a lot more than just one page. I use them for all Commons releases. What I'm more interested in getting rid of is the commons-skin plug-in but I don't know if it's possible to fold it in commons-parent directly. It would be nice to merge the Build and Release plugin but I never took the time to do it. Ideally, I'd prefer to have all three current plug-ins in commons-parent, so I have 1 framework-y thing to deal with instead of 4.
Member
Author
There was a problem hiding this comment. I know that Build and Release plugins are not deprecated but use deprecated ant mojo |
||
| </modules> | ||
|
|
||
| <scm> | ||
|
|
@@ -958,8 +959,9 @@ under the License. | |
| <!-- DO NOT UPGRADE to 4: incompatible with Maven 3 --> | ||
| <version.plexus-xml>3.0.1</version.plexus-xml> | ||
| <versions.junit5>5.11.3</versions.junit5> | ||
| <version.maven-fluido-skin>2.0.0</version.maven-fluido-skin> | ||
| <version.maven-shared-resources>6</version.maven-shared-resources> | ||
| <version.maven-site-plugin>3.21.0</version.maven-site-plugin> | ||
| <project.build.outputTimestamp>2024-07-04T20:44:45Z</project.build.outputTimestamp> | ||
| </properties> | ||
|
|
||
|
|
@@ -1230,6 +1232,25 @@ under the License. | |
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-remote-resources-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>site-download</id> | ||
| <goals> | ||
| <goal>process</goal> | ||
| </goals> | ||
| <phase>none</phase> | ||
|
Member
There was a problem hiding this comment. I would rather bind this to
Member
Author
There was a problem hiding this comment. due to inheritance we can put here pre-site |
||
| <configuration> | ||
| <resourceBundles> | ||
| <bundle>org.apache.maven:maven-shared-doc-resource:44-SNAPSHOT</bundle> | ||
| </resourceBundles> | ||
| <outputDirectory>${project.build.directory}/generated-site</outputDirectory> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </pluginManagement> | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
instead of putting this config into each pom leveraging the templates, I would rather set https://maven.apache.org/plugins/maven-remote-resources-plugin/process-mojo.html#skip based on the values of
downloadDirectory/downloadArtifactin the main parent pom.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in the most of we have a download page in project root pom, properties will also available in childs ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right, one possible way is to set the properties only for the current pom, but not if used as parent (https://github.com/apache/maven-apache-parent/blob/061e19af986a914df4d37b14e7e53a079d9033c5/pom.xml#L486)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it will be more complicated ... we will need a mark file in all project