[openwhisk-release] branch master updated: Inject doc on restoring gradle-wrapper.jar into release tar balls. (#354)

[dg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dgrove pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-release.git


The following commit(s) were added to refs/heads/master by this push:
     new 6320dd7  Inject doc on restoring gradle-wrapper.jar into release tar balls. (#354)
6320dd7 is described below

commit 6320dd7cb5a508e157e8eab2b1741244fdd89b4f
Author: David Grove <dg...@users.noreply.github.com>
AuthorDate: Fri Oct 30 18:31:38 2020 -0400

    Inject doc on restoring gradle-wrapper.jar into release tar balls. (#354)
---
 release-docs/BUILDING_FROM_SOURCE.md | 51 ++++++++++++++++++++++++++++++++++++
 tools/package_source_code.sh         |  2 ++
 2 files changed, 53 insertions(+)

diff --git a/release-docs/BUILDING_FROM_SOURCE.md b/release-docs/BUILDING_FROM_SOURCE.md
new file mode 100644
index 0000000..b86b211
--- /dev/null
+++ b/release-docs/BUILDING_FROM_SOURCE.md
@@ -0,0 +1,51 @@
+<!--
+#
+# 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.
+#
+-->
+
+# Building an Apache OpenWhisk release from source
+
+## Restore the Gradle Wrapper Jar
+
+Most of the Apache OpenWhisk components use the [Gradle](https://gradle.org)
+build tool.  As described in more detail in the
+[Gradle Wrapper documentation](https://docs.gradle.org/current/userguide/gradle_wrapper.html),
+Gradle is designed to securely bootstrap itself from a small jar file
+which is normally located in each OpenWhisk source tree at
+`gradle/wrapper/gradle-wrapper.jar`.
+
+However, including the binary `gradle-wrapper.jar` is not allowed in
+Apache source releases.  Therefore, if after unpacking an OpenWhisk
+source release you see a `build.gradle` at the top level of the source tree
+you will have to restore the missing jar file before you can build anything.
+
+If you have a compatible version of `gradle` already installed on your
+machine, this can be done by performing the following steps.
+
+1. Inspect `gradle/wrapper/gradle-wrapper.properties` to determine the expected version of gradle. Look for
+the version number embedded in the distributionUrl property.
+2. Execute the command `gradle wrapper --gradle-version X.Y.Z` replacing X.Y.Z with the version number from `gradle-wrapper.properties`.
+
+If this command succeeds, you should now be able to execute `./gradlew` to download the right version of
+gradle and build OpenWhisk. Consult the README.md for component-specific detailed instructions, such as the build target.
+
+The command may fail because your version of gradle is incompatible
+with the build.gradle files included in the project.  If this happens,
+you can either (a) install the matching version of gradle or (b)
+execute the `gradle wrapper --gradle-version X.Y.Z` command in a
+scratch directory and then manually copy `gradle-wrapper.jar` to
+`gradle/wrapper`.
diff --git a/tools/package_source_code.sh b/tools/package_source_code.sh
index dbda375..c9782af 100755
--- a/tools/package_source_code.sh
+++ b/tools/package_source_code.sh
@@ -39,6 +39,8 @@ do
     repo_name=$(echo "$repo" | sed -e 's/^"//' -e 's/"$//')
     project_name="$repo_name"
     rm -rf $OPENWHISK_CLEANED_SOURCE_DIR/$project_name/.git
+    # Inject generic info from release-docs into release
+    cp "$PARENTDIR"/release-docs/BUILDING_FROM_SOURCE.md $OPENWHISK_CLEANED_SOURCE_DIR/$project_name/
     cd $OPENWHISK_CLEANED_SOURCE_DIR
     # Rename the directory by adding the version number
     mv $project_name $project_name-$version