Bugfix deploy_npm rule (#177)

## What is the goal of this PR?

Allow release deployment of NPM packages

## What are the changes implemented in this PR?

- Copy unmodified package when deploying release (otherwise `npm` doesn't find it)
- refactor: separate old and new filenames or npm archives to constants
- chore: remove old Bash implementation of `deploy_npm`
- chore: add Apache license header to `npm/templates/BUILD`
- chore: regenerate docs

Author: vmax

README.md

@@ -1892,7 +1892,7 @@ Assemble package for installation with RPM
 ## assemble_targz
 
 <pre>
-assemble_targz(<a href="#assemble_targz-name">name</a>, <a href="#assemble_targz-output_filename">output_filename</a>, <a href="#assemble_targz-targets">targets</a>, <a href="#assemble_targz-additional_files">additional_files</a>, <a href="#assemble_targz-empty_directories">empty_directories</a>, <a href="#assemble_targz-permissions">permissions</a>, <a href="#assemble_targz-visibility">visibility</a>)
+assemble_targz(<a href="#assemble_targz-name">name</a>, <a href="#assemble_targz-output_filename">output_filename</a>, <a href="#assemble_targz-targets">targets</a>, <a href="#assemble_targz-additional_files">additional_files</a>, <a href="#assemble_targz-empty_directories">empty_directories</a>, <a href="#assemble_targz-permissions">permissions</a>, <a href="#assemble_targz-visibility">visibility</a>, <a href="#assemble_targz-tags">tags</a>)
 </pre>
 
 Assemble distribution archive (.tar.gz)
@@ -1969,6 +1969,12 @@ Assemble distribution archive (.tar.gz)
         </p>
       </td>
     </tr>
+    <tr id="assemble_targz-tags">
+      <td><code>tags</code></td>
+      <td>
+        optional. default is <code>[]</code>
+      </td>
+    </tr>
   </tbody>
 </table>
 

npm/templates/BUILD

@@ -1,2 +1,20 @@
+#
+# 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.
+#
 
-exports_files(["deploy.py", "deploy.sh"])
+exports_files(["deploy.py"])

npm/templates/deploy.py

@@ -25,6 +25,7 @@
 import json
 import os
 import subprocess
+import shutil
 
 # usual importing is not possible because
 # this script and module with common functions
@@ -43,6 +44,9 @@ def git_commit():
     ], cwd=os.getenv('BUILD_WORKSPACE_DIRECTORY')).decode().strip()
 
 
+ORIGINAL_FILENAME = 'deploy_npm.tgz'
+MODIFIED_FILENAME = 'deploy_npm_updated.tgz'
+
 parser = argparse.ArgumentParser()
 parser.add_argument('repo_type')
 args = parser.parse_args()
@@ -118,7 +122,7 @@ def git_commit():
 
 if args.repo_type == 'snapshot':
     print('Appending git commit to version')
-    with tarfile.open('deploy_npm.tgz') as tf, tarfile.open('deploy_npm_updated.tgz', 'w:gz') as tfu:
+    with tarfile.open(ORIGINAL_FILENAME) as tf, tarfile.open(MODIFIED_FILENAME, 'w:gz') as tfu:
         pkg_json_file = tf.extractfile('package/package.json')
         pkg_json = json.loads(pkg_json_file.read().decode())
         pkg_json['version'] += "-{}".format(git_commit())
@@ -132,12 +136,14 @@ def git_commit():
                 info.size = content.tell()
                 content.seek(0)
             tfu.addfile(info, content)
+else:
+    shutil.copyfile(ORIGINAL_FILENAME, MODIFIED_FILENAME)
 
 subprocess.check_call([
     'npm',
     'publish',
     '--registry={}'.format(npm_registry),
-    'deploy_npm_updated.tgz'
+    MODIFIED_FILENAME
 ], env={
     'PATH': ':'.join([
         '/usr/bin/',
@@ -149,4 +155,4 @@ def git_commit():
     ])
 })
 
-os.remove('deploy_npm_updated.tgz')
+os.remove(MODIFIED_FILENAME)