Adding site deploy script for archiva-docs. Using https urls.

This commit is contained in:
Martin Stockhammer 2018-11-22 20:32:24 +01:00
parent f528b1addc
commit 920083ef54
8 changed files with 161 additions and 12 deletions

View File

@ -1 +0,0 @@
to deploy site: sh ./deploySite.sh

81
archiva-docs/README.adoc Normal file
View File

@ -0,0 +1,81 @@
Archiva Documentation - User Documentation
===========================================
:toc:
== How to build and publish the pages for the archiva web content
This module and the children contain web content and project reports that can be published to the
archiva web site: https://archiva.apache.org
The web content parts of this module and submodules are published to the path
/docs/${project.version}/
=== Use the script
There is a shell script +deploySite.sh+ which you can run to generate the site check and publish to
the remote repository. It works only on Linux, on other platforms you have to go the next section.
The script is interactive, it asks you to confirm the publish after generation of the staging part.
.Execute
./deploySite.sh
All arguments are appended to the mvn calls.
=== Run the mvn steps manually
==== Building the pages
You need enough free disk space to publish the web content. The archiva web site repository is big,
but the maven build will only checkout the necessary directories for this build (sparse checkout).
For all the commands you have to change to this archiva-modules directory:
cd archiva/archiva-modules
.The following creates the site to the staging folder
mvn clean site site:stage
The result can be checked in
archiva-modules/target/staging/ref/${project.version}
with your browser.
If you would like the use a local checkout of the archiva-web-content.git repository and not push directly
to the remote repository, you may add this parameter:
-DsiteRepositoryUrl=scm:git:file:///${path-to-your-local-archiva}/archiva-web-content.git
where +${path-to-your-local-archiva}+ is the path where a bare clone of the archiva-web-content.git is stored.
NOTE: You cannot use +mvn site:run+ because this will place the submodules into the same folder and
overwrite each other.
==== Publish the pages
.This command publishes to the git repository
mvn scm-publish:publish-scm
After publishing to the git repository the gitpubsub mechanism is transferring it to the HTTP server.
If you would like the use a local checkout of the archiva-web-content.git repository and not push directly
to the remote repository, you may add this parameter:
-DsiteRepositoryUrl=scm:git:file:///${path-to-your-local-archiva}/archiva-web-content.git
=== Some notes about the build process
A sparse checkout of the git repository will be created in
.site-content
but only, if the directory +.site-content/.git+ does not exist.

61
archiva-docs/deploySite.sh Executable file
View File

@ -0,0 +1,61 @@
#!/bin/bash
#
# 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.
#
# Author: Martin Stockhammer <martin_s@apache.org>
# Date: 2018-11-15
#
# Publishes the site content and generated reports to the web content repository.
# It stops after the staging and let you check the content before pushing to the repository
#
THIS_DIR=$(dirname $0)
THIS_DIR=$(readlink -f ${THIS_DIR})
CONTENT_DIR=".site-content"
PROJECT_VERSION=$(grep '<version>' pom.xml |head -1 | sed -e 's/.*<version>\(.*\)<\/version>.*/\1/g')
SUB_DIR="docs/${PROJECT_VERSION}"
if [ -d "${CONTENT_DIR}/.git" ]; then
git -C "${CONTENT_DIR}" fetch origin
git -C "${CONTENT_DIR}" reset --hard origin/master
fi
echo ">>>> Creating site and reports <<<<"
mvn clean site site:stage "$@"
echo "*****************************************"
echo ">>>> Finished the site stage process <<<<"
echo "> You can check the content in the folder target/staging or by opening the following url"
echo "> file://${THIS_DIR}/target/staging/${SUB_DIR}/index.html"
echo "> "
echo "> If everything is fine enter yes. After that the publish process will be started."
echo -n "Do you want to publish (yes/no)? "
read ANSWER
if [ "${ANSWER}" == "yes" -o "${ANSWER}" == "YES" ]; then
echo "> Starting publish process"
mvn scm-publish:publish-scm "$@"
else
echo "> Aborting now"
echo "> Running git reset in .site-content directory"
git -C "${CONTENT_DIR}" fetch origin
git -C "${CONTENT_DIR}" reset --hard origin/master
echo ">>>> Finished <<<<"
fi

View File

@ -27,15 +27,15 @@
<artifactId>archiva-docs</artifactId> <artifactId>archiva-docs</artifactId>
<packaging>pom</packaging> <packaging>pom</packaging>
<name>Archiva :: Documentation</name> <name>Archiva :: Documentation</name>
<url>http://archiva.apache.org/docs/${project.version}/</url> <url>https://archiva.apache.org/docs/${project.version}/</url>
<properties> <properties>
<siteFilePath>${user.home}/archiva-sites/archiva-docs-${project.version}/</siteFilePath> <siteFilePath>${user.home}/archiva-sites/archiva-docs-${project.version}/</siteFilePath>
<scmPubCheckoutDirectory>${basedir}/.site-content</scmPubCheckoutDirectory>
<maven.build.timestamp.format>yyyy-MM-dd</maven.build.timestamp.format> <maven.build.timestamp.format>yyyy-MM-dd</maven.build.timestamp.format>
<releaseDate>${maven.build.timestamp}</releaseDate> <releaseDate>${maven.build.timestamp}</releaseDate>
<!-- The git repository, where the site content is placed --> <!-- The git repository, where the site content is placed -->
<siteRepositoryUrl>scm:git:https://gitbox.apache.org/repos/asf/archiva-web-content-INVALID.git</siteRepositoryUrl> <siteRepositoryUrl>scm:git:https://gitbox.apache.org/repos/asf/archiva-web-content-INVALID.git</siteRepositoryUrl>
<scmPubCheckoutDirectory>${basedir}/.site-content</scmPubCheckoutDirectory>
</properties> </properties>
<build> <build>
@ -161,8 +161,8 @@
<reportSets> <reportSets>
<reportSet> <reportSet>
<reports> <reports>
<report>license</report> <report>licenses</report>
<report>project-team</report> <report>team</report>
</reports> </reports>
</reportSet> </reportSet>
</reportSets> </reportSets>

View File

@ -48,8 +48,13 @@
</twitter> </twitter>
<ohloh> <ohloh>
<projectId>6670</projectId> <projectId>6670</projectId>
<widget>stats</widget> <widget>thin-badge</widget>
</ohloh> </ohloh>
<gitHub>
<projectId>apache/archiva</projectId>
<ribbonOrientation>right</ribbonOrientation>
<ribbonColor>black</ribbonColor>
</gitHub>
</fluidoSkin> </fluidoSkin>
</custom> </custom>
@ -58,8 +63,11 @@
<version position="right" /> <version position="right" />
<body> <body>
<breadcrumbs> <breadcrumbs>
<item name="Apache Archiva" href="http://archiva.apache.org/index.html"/> <item name="Apache" href="https://www.apache.org" />
<item name="Archiva" href="https://archiva.apache.org" />
<item name="Archiva Documentation" href="index.html" />
</breadcrumbs> </breadcrumbs>
<menu name="Introduction"> <menu name="Introduction">

View File

@ -28,7 +28,7 @@
<artifactId>archiva-modules</artifactId> <artifactId>archiva-modules</artifactId>
<packaging>pom</packaging> <packaging>pom</packaging>
<name>Archiva :: Modules</name> <name>Archiva :: Modules</name>
<url>http://archiva.apache.org/ref/${project.version}</url> <url>https://archiva.apache.org/ref/${project.version}</url>
<properties> <properties>
<scmPubCheckoutDirectory>${basedir}/.site-content</scmPubCheckoutDirectory> <scmPubCheckoutDirectory>${basedir}/.site-content</scmPubCheckoutDirectory>

View File

@ -51,9 +51,9 @@
<body> <body>
<breadcrumbs> <breadcrumbs>
<!-- TODO: need to stop them inheriting <item name="Apache" href="https://www.apache.org" />
<item name="Reports" href="/reports" /> <item name="Archiva" href="https://archiva.apache.org" />
--> <item name="Archiva Modules" href="index.html" />
</breadcrumbs> </breadcrumbs>
<menu name="Developers"> <menu name="Developers">

View File

@ -31,7 +31,7 @@
<packaging>pom</packaging> <packaging>pom</packaging>
<name>Apache Archiva</name> <name>Apache Archiva</name>
<url>http://archiva.apache.org</url> <url>https://archiva.apache.org</url>
<modules> <modules>
<module>archiva-cli</module> <module>archiva-cli</module>