pritidesai closed pull request #885: Update .md and .sh files to pass scancode with latest .cfg URL: https://github.com/apache/incubator-openwhisk-wskdeploy/pull/885
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c32a97e6..4dca9344 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.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. # @@ -35,18 +35,18 @@ Instructions on how to do this can be found here: [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 on the respective project repository's GitHub issue tracker. Be sure to search the +Please raise any bug reports 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. ### Discussion diff --git a/README.md b/README.md index 3879fa9a..321fb5c1 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ `wskdeploy` is a utility to help you describe and deploy any part of the OpenWhisk programming model using a Manifest file written in YAML. Use it to deploy all your OpenWhisk [Packages](https://github.com/apache/incubator-openwhisk/blob/master/docs/packages.md), [Actions](https://github.com/apache/incubator-openwhisk/blob/master/docs/actions.md), [Triggers, and Rules](https://github.com/apache/incubator-openwhisk/blob/master/docs/triggers_rules.md) using a single command! -`wskdeploy export --projectname managed_project_name` allows to "export" a specified managed project into a local file system. Namely, a `managed_project_name.yml` Manifest file will be created automatically. This Manifest file can be used with `wskdeploy` to redeploy the managed project at a different OpenWhisk instance. If the managed project contains dependencies on other managed projects, then these projects will be exported automatically into their respective manifests. +`wskdeploy export --projectname managed_project_name` allows to "export" a specified managed project into a local file system. Namely, a `managed_project_name.yml` Manifest file will be created automatically. This Manifest file can be used with `wskdeploy` to redeploy the managed project at a different OpenWhisk instance. If the managed project contains dependencies on other managed projects, then these projects will be exported automatically into their respective manifests. You can use this in addition to the OpenWhisk CLI. In fact, this utility uses the [OpenWhisk "Go" Client](https://github.com/apache/incubator-openwhisk-client-go) to create its HTTP REST calls for deploying and undeploying your packages. @@ -223,7 +223,7 @@ while there, you can verify that your upstream repository is set correctly: #### Git clone RPC failed: HTTP 301 -This sometimes occurs using "go get" the wskdeploy code (which indirectly invokes "git clone"). +This sometimes occurs using "go get" the wskdeploy code (which indirectly invokes "git clone"). <b>Note: Using "go get" for development is unsupported; instead, please use "go deps" for dependency management.</b> diff --git a/build.sh b/build.sh index 92f689b8..2b535a22 100644 --- a/build.sh +++ b/build.sh @@ -1,23 +1,19 @@ -#!/bin/bash +#!/usr/bin/env 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 # -# 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. +# 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. # set +x diff --git a/docs/sync_projects_between_client_and_server.md b/docs/sync_projects_between_client_and_server.md index 20a1f6bc..82a7d9f9 100644 --- a/docs/sync_projects_between_client_and_server.md +++ b/docs/sync_projects_between_client_and_server.md @@ -26,7 +26,7 @@ Whisk Deploy in `sync` mode, deploys all Apache OpenWhisk entities from the mani whisk-managed: projectName: <project-name> projectHash: SHA1("OpenWhisk " + <size_of_manifest_file> + "\0" + <contents_of_manifest_file>) - projectDeps: <list of dependent packages> + projectDeps: <list of dependent packages> file: Relative path of manifest file on the file system ``` @@ -42,7 +42,7 @@ Project name in the manifest file is mandatory to sync that project between the ``` project: - name: <project-name> + name: <project-name> packages: package1: .... @@ -55,7 +55,7 @@ OpenWhisk entities which are deployed using some other tool or automation and we Undeployment of such project can be driven by `wskdeploy` with: ``` -wskdeploy undeploy --projectname <project-name> +wskdeploy undeploy --projectname <project-name> ``` Lets look at a sample project to understand sync mode. Whisk Deploy GitHub repo has a sample project with many different manifest files to demonstrate sync mode. @@ -63,7 +63,7 @@ Lets look at a sample project to understand sync mode. Whisk Deploy GitHub repo #### Step 1: Deploy MyFirstManagedProject using `sync`: ``` -~/wskdeploy sync -m manifest.yaml +~/wskdeploy sync -m manifest.yaml Success: Deployment completed successfully. ``` @@ -113,7 +113,7 @@ bx wsk package get ManagedPackage-1 #### Step 2: Sync Client and Server — Deleting ManagedPackage-2 ``` -~/wskdeploy sync -m 00-manifest-minus-second-package.yaml +~/wskdeploy sync -m 00-manifest-minus-second-package.yaml Deployment completed successfully. ``` @@ -140,7 +140,7 @@ rules #### Step 3: Sync Client and Server — Deleting Sequence ManagedSequence-2 ``` -~/wskdeploy sync -m 01-manifest-minus-sequence-2.yaml +~/wskdeploy sync -m 01-manifest-minus-sequence-2.yaml Deployment completed successfully. ``` @@ -329,7 +329,7 @@ ok: got package Extension2 Here, on server side, package `Extension2` is showing both dependencies (1) `helloworlds` and (2) `hellowhisk`. Now, when we try to undeploy `Extension2` using `~/wskdeploy undeploy --projectname MyManagedProjectWithDependency`, only one dependency `hellowhisk` is deleted and the other dependency `helloworlds` is not deleted as its referred by `Extension1`. - + > **Note:** Here the dependent package belongs to project `HelloWorlds` which > has a single package `helloworlds`. Whisk Deploy does not support having > dependencies with multiple packages. The reason behind this limitation is > when a dependency is specified in manifest file using label > (`custom-hellowhisk`) which is different than the dependent package name > (`hellowhisk`), `custome-hellowhisk` is created as a binding to > `hellowhisk`. OpenWhisk does not support creating a package which is bound > to multiple packages. ### Package Binding @@ -409,4 +409,3 @@ ok: got package whiskUtility ``` Now, when we undeploy `Extension3` with `~/wskdeploy undeploy --projectname MyManagedProjectWithWhiskSystemDependency`, nothing changes under `/whisk.system`. `utils` package under `/whisk.system` remains undeployed. Similarly, with an undeployment of `Extension3`, `/<namespace>/<package>` is not deleted. - diff --git a/tests/usecases/dependency/README.md b/tests/usecases/dependency/README.md index f745ca1e..024b43ec 100644 --- a/tests/usecases/dependency/README.md +++ b/tests/usecases/dependency/README.md @@ -16,7 +16,7 @@ # --> -# Dependent Packages with `wskdeploy` +# Dependent Packages with `wskdeploy` `wskdeploy` supports dependencies where it allows you to declare other OpenWhisk packages that your application or project (manifest) is dependent on. With declaring diff --git a/tools/travis/build_tag_releases.sh b/tools/travis/build_tag_releases.sh index 799c547c..62bd5209 100755 --- a/tools/travis/build_tag_releases.sh +++ b/tools/travis/build_tag_releases.sh @@ -1,23 +1,19 @@ #!/usr/bin/env 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 # -# 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. +# 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. # declare -a os_list=("linux" "darwin" "windows") diff --git a/tools/travis/cloneutils.sh b/tools/travis/cloneutils.sh index 51c2b7ce..e60781e2 100755 --- a/tools/travis/cloneutils.sh +++ b/tools/travis/cloneutils.sh @@ -1,23 +1,19 @@ -#!/bin/bash +#!/usr/bin/env 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 # -# 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. +# 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. # set -o xtrace diff --git a/tools/travis/docker/publish.sh b/tools/travis/docker/publish.sh index eb0ffa3a..361630dd 100755 --- a/tools/travis/docker/publish.sh +++ b/tools/travis/docker/publish.sh @@ -1,23 +1,19 @@ -#!/bin/bash +#!/usr/bin/env 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 # -# 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. +# 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. # set -eu diff --git a/tools/travis/scancode.sh b/tools/travis/scancode.sh index 17c9bdec..0f4205ad 100755 --- a/tools/travis/scancode.sh +++ b/tools/travis/scancode.sh @@ -1,23 +1,19 @@ -#!/bin/bash +#!/usr/bin/env 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 # -# 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. +# 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. # set -e @@ -28,4 +24,4 @@ UTILDIR="$ROOTDIR/../incubator-openwhisk-utilities" # run scancode using the ASF Release configuration cd $UTILDIR -scancode/scanCode.py --config scancode/ASF-Release.cfg $ROOTDIR +scancode/scanCode.py --config scancode/ASF-Release-v2.cfg $ROOTDIR diff --git a/tools/travis/script.sh b/tools/travis/script.sh index b0c7d5f4..923905de 100755 --- a/tools/travis/script.sh +++ b/tools/travis/script.sh @@ -1,23 +1,19 @@ #!/usr/bin/env 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 # -# 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. +# 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. # set -e ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
