Review and update README instructions (#13)

* fix spelling of required_approving_review_count field

* fix use of VSCode, should be VS Code

following format from vsc-extension-quickstart.md

* expand section on debugging extension locally

* add suggested revisions to README

* add note about self signed certificates
2 files changed
tree: d3fb9585d16278c1f7a240448e3b347945f38824
  1. .asf.yaml
  2. .github/
  3. .gitignore
  4. CHANGELOG.md
  5. LICENSE.txt
  6. NOTICE.txt
  7. README.md
  8. package-lock.json
  9. package.json
  10. resource/
  11. src/
  12. test-fixtures/
  13. travis/
  14. tsconfig.json
  15. vsc-extension-quickstart.md
  16. webpack.config.js
  17. webview-template/
  18. wskdeploy-template/
README.md

OpenWhisk VS Code Extension

An openwhisk-vscode-extension is an open-source VS Code extension for Apache OpenWhisk. It manages the wskdeploy manifest file and makes deployment easy. You can also create and update actions and packages in VS Code.

Try creating and editing your action code in the VS Code!

Prerequisites

Install the dependencies below to use full features:

This extension finds the .wskprops configuration file located in the home path and connects to the Openwhisk server automatically. Set up your configuration referred to the cli docs.

Features

OpenWhisk Explorer

  • Explore all entities in your endpoints/namespaces.
    • The .wskprops file is automatically registered.
    • You can add the API host manually.
    • You can add the namespace manually by API auth key.
  • Show the action code with syntax highlighting.
  • Edit the action code on the remote server.
  • Invoke the action remotely and get the activation result.
  • Show a list of actions related to the sequence action.
  • Show information about the trigger and related rules.
  • Show activations related to the action (Same as wsk activation list <action>).
  • Show detailed information of the activation (Same as wsk activation get <activation_id>).
  • Update parameters and annotations of the action, package, and trigger.

Manifest View (in the workspace explorer)

  • List up manifest YAML files in the workspace.
  • Deploy/Undeploy OpenWhisk packages with manifest (via wskdeploy).
    • Deploy with the deployment file.
    • Deploy with multiple credentials.

Commands

This extension contributes the following commands to the Command palette.

  • Create a wskdeploy project: creates a wskdeploy project

How to debug in your local environment

Requirements

  • vscode >= 1.41.0
  • Node.js >= 12.x
  • Have an OpenWhisk deployment available, which you set up by following this guide or by using one of the managed OpenWhisk offerings (e.g., from IBM, Adobe or Nimbella). Note, deployments with self signed SSL certificates may not work with this extension.

Set up

  1. Clone the repository:

    git clone https://github.com/apache/openwhisk-vscode-extension.git
    code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VS Code
    
  2. In your terminal, execute the command npm install to install extension dependencies

  3. In your terminal, execute the command npm run webpack-dev to start up the extension builder in watch mode (allows for making changes to files and rebuilding automatically)

  4. Open up the src/extension.ts file for editing

  5. In the src/extension.ts file press F5 button to start debugger and select VS Code Extension Development if a modal appears at the top of the VS Code window

  6. Interact with the DEBUG CONSOLE for real time debugging of the extension and learn more about debugging here

License

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.

Third-party Product Acknowledgement

Portions of this product include SVG files developed by the XEIcon project (https://github.com/xpressengine/XEIcon).

Those files are distributed under the XEIcon license (https://github.com/xpressengine/XEIcon#license).