https://github.com/whitesource/wss-serverless-plugin

whitesource serverless plugin
https://github.com/whitesource/wss-serverless-plugin

Last synced: 11 months ago
JSON representation

whitesource serverless plugin

• Host: GitHub
• URL: https://github.com/whitesource/wss-serverless-plugin
• Owner: whitesource
• Created: 2019-07-31T13:36:23.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-11-18T10:49:26.000Z (over 6 years ago)
• Last Synced: 2025-03-30T11:16:28.093Z (about 1 year ago)
• Language: JavaScript
• Size: 32.2 KB
• Stars: 1
• Watchers: 15
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-2.0.txt

Awesome Lists containing this project

README

          
serverless-whitesource

=======

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)

[![WhiteSource](https://www.whitesourcesoftware.com/wp-content/uploads/2016/06/whitesource_logo_rgb-02.png)](https://www.whitesourcesoftware.com)

# Description

Perform a WhiteSource scan for Serverless functions after deployment. 

# Requirements

- [Serverless Framework](https://github.com/serverless/serverless) 1.49.0 or higher

- [WhiteSource Unified Agent] (https://whitesource.atlassian.net/wiki/spaces/WD/pages/33718339/Unified+Agent) 19.7.2 or higher

# Installation

```

npm install serverless-whitesource

```

```

sudo npm install -g serverless #this step is required only in the first run

```

# Configuration

### serverless.yml

```yaml

plugins:

  - serverless-whitesource

custom:

  whitesource:

    pathToConfig: ${path-to-configuration-file}

    pathToJar: ${path-to-UA-jar-file}

    [optional] wss-{valid UA's command-line paramter}: {parameter value}

```

# Usage

### 1. Download the UA jar

```

curl -LJO https://wss-qa.s3.amazonaws.com/unified-agent/integration/wss-unified-agent

```

### 2. Install WhiteSource plugin

```

npm install serverless-whitesource

```

### 3. Update the serverless.yml with the path to the configuration-file, jar-file and relevant parameters

### 4. Deploy the serverless function(s)

```

sls deploy

```

Authors

-------

Created and maintained by [WhiteSource Software](https://www.whitesourcesoftware.com) ()

License

-------

Apache 2.0 License (see [LICENSE](https://www.apache.org/licenses/LICENSE-2.0.txt))