kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From granthe...@apache.org
Subject [kudu] 02/03: Autogenerate the release index.md file
Date Fri, 12 Jul 2019 18:59:23 GMT
This is an automated email from the ASF dual-hosted git repository.

granthenke pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kudu.git

commit 99d1bc82034698b5fc7d74e4bd2117a2ce9fc96b
Author: Grant Henke <granthenke@apache.org>
AuthorDate: Thu Jul 11 08:16:00 2019 -0500

    Autogenerate the release index.md file
    
    When building the docs for a release, this patch
    also builds the index.md file.
    
    Change-Id: If93fe00aa0dd855d8f8fafa22c786747d2ae50ed
    Reviewed-on: http://gerrit.cloudera.org:8080/13844
    Reviewed-by: Alexey Serbin <aserbin@cloudera.com>
    Tested-by: Kudu Jenkins
---
 docs/support/scripts/index_template.md | 56 ++++++++++++++++++++++++++++++++++
 docs/support/scripts/make_site.sh      | 10 ++----
 2 files changed, 59 insertions(+), 7 deletions(-)

diff --git a/docs/support/scripts/index_template.md b/docs/support/scripts/index_template.md
new file mode 100644
index 0000000..c1886b3
--- /dev/null
+++ b/docs/support/scripts/index_template.md
@@ -0,0 +1,56 @@
+---
+title: Apache Kudu release @@KUDU_VERSION@@
+layout: single_col
+active_nav: download
+single_col_extra_classes: releases
+---
+
+<!--
+
+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.
+
+-->
+
+## Apache Kudu release @@KUDU_VERSION@@
+
+See the [Kudu @@KUDU_VERSION@@ Release Notes](docs/release_notes.html).
+
+Downloads of Kudu @@KUDU_VERSION@@ are available in the following formats:
+
+* [Kudu @@KUDU_VERSION@@ source tarball](http://www.apache.org/dyn/closer.cgi?path=kudu/@@KUDU_VERSION@@/apache-kudu-@@KUDU_VERSION@@.tar.gz)
+  ([SHA512](https://www.apache.org/dist/kudu/@@KUDU_VERSION@@/apache-kudu-@@KUDU_VERSION@@.tar.gz.sha512),
+  [Signature](https://www.apache.org/dist/kudu/@@KUDU_VERSION@@/apache-kudu-@@KUDU_VERSION@@.tar.gz.asc))
+
+You can use the [KEYS file](https://www.apache.org/dist/kudu/KEYS) to verify the included
GPG signature.
+
+To verify the integrity of the release, check the following:
+
+* Verify the checksum by downloading the release and the `.sha512` file, and
+  running the following command:
+    * On Linux: `sha512sum -c apache-kudu-@@KUDU_VERSION@@.tar.gz.sha512`
+    * On MacOS: `shasum -a 512 -c apache-kudu-@@KUDU_VERSION@@.tar.gz.sha512`
+* Verify the signature by downloading the release and the `.asc` file, and
+  doing the following:
+    * Import the KEYS file to the GPG keychain by running `gpg --import KEYS`
+    * Run `gpg --verify apache-kudu-@@KUDU_VERSION@@.tar.gz.asc apache-kudu-@@KUDU_VERSION@@.tar.gz`
+
+Additional links:
+
+* [Kudu @@KUDU_VERSION@@ Documentation](docs/)
+* [Kudu @@KUDU_VERSION@@ Java API docs](apidocs/)
+* [Kudu @@KUDU_VERSION@@ C++ API docs](cpp-client-api/)
\ No newline at end of file
diff --git a/docs/support/scripts/make_site.sh b/docs/support/scripts/make_site.sh
index 0d7d738..1a76e05 100755
--- a/docs/support/scripts/make_site.sh
+++ b/docs/support/scripts/make_site.sh
@@ -161,13 +161,9 @@ if [ -n "$OPT_DOXYGEN" ]; then
   fi
 fi
 
-SITE_SUBDIRS="docs"
-if [ -n "$OPT_JAVADOC" ]; then
-  SITE_SUBDIRS="$SITE_SUBDIRS $JAVADOC_SUBDIR"
-fi
-if [ -n "$OPT_DOXYGEN" ]; then
-  SITE_SUBDIRS="$SITE_SUBDIRS $CPP_CLIENT_API_SUBDIR"
-fi
+# Generate the release index file.
+sed "s/@@KUDU_VERSION@@/$VERSION/g" "$SOURCE_ROOT/docs/support/scripts/index_template.md"
> \
+  "$RELEASE_OUTPUT_DIR/index.md"
 
 cd "$SITE_OUTPUT_DIR"
 SITE_ARCHIVE="$SITE_OUTPUT_DIR/website_archive.zip"


Mime
View raw message