Update .md and .sh files to pass scancode with latest .cfg
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c29a74e..df6e905 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,22 +1,23 @@
-[](http://www.apache.org/licenses/LICENSE-2.0)
<!--
#
-# Licensed to the Apache Software Foundation (ASF) under one or more contributor
-# license agreements. See the NOTICE file distributed with this work for additional
+# 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
+# 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
+# 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.
#
-->
+[](http://www.apache.org/licenses/LICENSE-2.0)
+
# Contributing to Apache OpenWhisk
Anyone can contribute to the OpenWhisk project and we welcome your contributions.
@@ -36,18 +37,18 @@
[http://www.apache.org/licenses/#clas](http://www.apache.org/licenses/#clas)
Once submitted, you will receive a confirmation email from the Apache Software Foundation (ASF) and be added to
-the following list: http://people.apache.org/unlistedclas.html.
+the following list: http://people.apache.org/unlistedclas.html.
Project committers will use this list to verify pull requests (PRs) come from contributors that have signed a CLA.
-We look forward to your contributions!
+We look forward to your contributions!
## Raising issues
-Please raise any bug reports or enhancement requests on the respective project repository's GitHub issue tracker. Be sure to search the
+Please raise any bug reports or enhancement requests on the respective project repository's GitHub issue tracker. Be sure to search the
list to see if your issue has already been raised.
-A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong.
+A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong.
Provide as much context as possible so we can try to recreate the issue.
A good enhancement request comes with an explanation of what you are trying to do and how that enhancement would help you.
diff --git a/README.md b/README.md
index 68d0083..2c672b8 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,23 @@
<!--
#
-# Licensed to the Apache Software Foundation (ASF) under one or more contributor
-# license agreements. See the NOTICE file distributed with this work for additional
+# 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
+# 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
+# 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 OpenWhisk runtimes for docker
+[](http://www.apache.org/licenses/LICENSE-2.0)
[](https://travis-ci.org/apache/incubator-openwhisk-runtime-docker)
@@ -55,7 +56,7 @@
Build and Push image
```
docker login
-./gradlew core:actionProxy:distDocker -PdockerImagePrefix=$prefix-user -PdockerRegistry=docker.io
+./gradlew core:actionProxy:distDocker -PdockerImagePrefix=$prefix-user -PdockerRegistry=docker.io
```
Deploy OpenWhisk using ansible environment that contains the runtime of type `blackboxes` with name `dockerskeleton`
@@ -90,10 +91,3 @@
wsk action update myAction myAction.zip --docker $user_prefix/dockerskeleton
```
The `$user_prefix` is usually your dockerhub user id.
-
-
-
-# License
-[Apache 2.0](LICENSE.txt)
-
-
diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md
index 5583f17..ceebe20 100644
--- a/core/CHANGELOG.md
+++ b/core/CHANGELOG.md
@@ -1,16 +1,16 @@
<!--
#
-# Licensed to the Apache Software Foundation (ASF) under one or more contributor
-# license agreements. See the NOTICE file distributed with this work for additional
+# 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
+# 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
+# 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.
#
diff --git a/core/actionProxy/README.md b/core/actionProxy/README.md
index 9f6b373..6875c5e 100644
--- a/core/actionProxy/README.md
+++ b/core/actionProxy/README.md
@@ -1,55 +1,39 @@
<!--
#
-# Licensed to the Apache Software Foundation (ASF) under one or more contributor
-# license agreements. See the NOTICE file distributed with this work for additional
+# 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
+# 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
+# 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.
#
-->
-Skeleton for "docker actions"
-================
+## Skeleton for "docker actions"
-The `dockerskeleton` base image is useful for actions that run scripts (e.g., bash, perl, python)
-and compiled binaries or, more generally, any native executable. It provides a proxy service
-(using Flask, a Python web microframework) that implements the required `/init` and `/run` routes
-to interact with the OpenWhisk invoker service. The implementation of these routes is encapsulated
-in a class named `ActionRunner` which provides a basic framework for receiving code from an invoker,
-preparing it for execution, and then running the code when required.
+The `dockerskeleton` base image is useful for actions that run scripts (e.g., bash, perl, python) and compiled binaries or, more generally, any native executable. It provides a proxy service (using Flask, a Python web microframework) that implements the required `/init` and `/run` routes to interact with the OpenWhisk invoker service. The implementation of these routes is encapsulated in a class named `ActionRunner` which provides a basic framework for receiving code from an invoker, preparing it for execution, and then running the code when required.
-The initialization of the `ActionRunner` is done via `init()` which receives a JSON object containing
-a `code` property whose value is the source code to execute. It writes the source to a `source` file.
-This method also provides a hook to optionally augment the received code via an `epilogue()` method,
-and then performs a `build()` to generate an executable. The last step of the initialization applies
-`verify()` to confirm the executable has the proper permissions to run the code. The action runner
-is ready to run the action if `verify()` is true.
+The initialization of the `ActionRunner` is done via `init()` which receives a JSON object containing a `code` property whose value is the source code to execute. It writes the source to a `source` file.
+
+This method also provides a hook to optionally augment the received code via an `epilogue()` method, and then performs a `build()` to generate an executable. The last step of the initialization applies `verify()` to confirm the executable has the proper permissions to run the code. The action runner is ready to run the action if `verify()` is true.
The default implementations of `epilogue()` and `build()` are no-ops and should be overridden as needed.
+
The base image contains a stub added which is already executable by construction via `docker build`.
-For language runtimes (e.g., C) that require compiling the source, the extending class should run the
-required source compiler during `build()`.
-The `run()` method runs the action via the executable generated during `init()`. This method is only called
-by the proxy service if `verify()` is true. `ActionRunner` subclasses are encouraged to override this method
-if they have additional logic that should cause `run()` to never execute. The `run()` method calls the executable
-via a process and sends the received input parameters (from the invoker) to the action via the command line
-(as a JSON string argument). Additional properties received from the invoker are passed on to the action via
-environment variables as well. To augment the action environment, override `env()`.
+For language runtimes (e.g., C) that require compiling the source, the extending class should run the required source compiler during `build()`.
-By convention the action executable may log messages to `stdout` and `stderr`. The proxy requires that the last
-line of output to `stdout` is a valid JSON object serialized to string if the action returns a JSON result.
+The `run()` method runs the action via the executable generated during `init()`. This method is only called by the proxy service if `verify()` is true. `ActionRunner` subclasses are encouraged to override this method if they have additional logic that should cause `run()` to never execute. The `run()` method calls the executable via a process and sends the received input parameters (from the invoker) to the action via the command line (as a JSON string argument). Additional properties received from the invoker are passed on to the action via environment variables as well. To augment the action environment, override `env()`.
+
+By convention the action executable may log messages to `stdout` and `stderr`. The proxy requires that the last line of output to `stdout` is a valid JSON object serialized to string if the action returns a JSON result.
+
A return value is optional but must be a JSON object (properly serialized) if present.
-For an example implementation of an `ActionRunner` that overrides `epilogue()` and `build()` see the
-[Swift 3](../swift3Action/swift3runner.py) action proxy. An implementation of the runner for Python actions
-is available [here](../pythonAction/pythonrunner.py). Lastly, an example Docker action that uses `C` is
-available in this [example](../../sdk/docker/Dockerfile).
+For an example implementation of an `ActionRunner` that overrides `epilogue()` and `build()` see the [Swift 3](../swift3Action/swift3runner.py) action proxy. An implementation of the runner for Python actions is available [here](../pythonAction/pythonrunner.py). Lastly, an example Docker action that uses `C` is available in this [example](../../sdk/docker/Dockerfile).
diff --git a/gradle/README.md b/gradle/README.md
index 5b83fdb..23cce13 100644
--- a/gradle/README.md
+++ b/gradle/README.md
@@ -1,16 +1,16 @@
<!--
#
-# Licensed to the Apache Software Foundation (ASF) under one or more contributor
-# license agreements. See the NOTICE file distributed with this work for additional
+# 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
+# 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
+# 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.
#
diff --git a/sdk/docker/README.md b/sdk/docker/README.md
index 86c69cf..6692ffe 100644
--- a/sdk/docker/README.md
+++ b/sdk/docker/README.md
@@ -1,23 +1,22 @@
<!--
#
-# Licensed to the Apache Software Foundation (ASF) under one or more contributor
-# license agreements. See the NOTICE file distributed with this work for additional
+# 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
+# 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
+# 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.
#
-->
-Blackbox Actions
-================
+## Blackbox Actions
1. Download and install the OpenWhisk CLI
2. Install OpenWhisk Docker action skeleton.
diff --git a/tools/travis/deploy.sh b/tools/travis/deploy.sh
index b6ebf05..861c042 100755
--- a/tools/travis/deploy.sh
+++ b/tools/travis/deploy.sh
@@ -50,7 +50,5 @@
WHISK_AUTH=`cat ${WHISKDIR}/ansible/files/auth.guest`
WHISK_CLI="${WHISKDIR}/bin/wsk -i"
-${WHISK_CLI} property set --apihost ${WHISK_APIHOST} --auth ${WHISK_AUTH}
+${WHISK_CLI} property set --apihost ${WHISK_APIHOST} --auth ${WHISK_AUTH}
${WHISK_CLI} property get
-
-
diff --git a/tools/travis/rename_sdk.sh b/tools/travis/rename_sdk.sh
index a01ca2f..9dfc3f7 100755
--- a/tools/travis/rename_sdk.sh
+++ b/tools/travis/rename_sdk.sh
@@ -29,8 +29,6 @@
if [ ${BUILD_TYPE} == "sdk" ]; then
find ${ROOTDIR}
- ls ${BUILDOUTPUTDIR}/
+ ls ${BUILDOUTPUTDIR}/
mv ${BUILDOUTPUTDIR}/blackbox.tar.gz ${BUILDOUTPUTDIR}/blackbox-${BUILD_VERSION}.tar.gz
fi
-
-
