Skip to content
This repository has been archived by the owner on Oct 28, 2021. It is now read-only.

Commit

Permalink
NPM Publish changes
Browse files Browse the repository at this point in the history
- Changed README as this is a Javascript repository only.
- Added map-stream to license validator.
- modified travis.yml as this is a Javascript only project.
  • Loading branch information
Evandro Carenho committed Mar 27, 2017
1 parent dc589e6 commit 09662e2
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 56 deletions.
18 changes: 6 additions & 12 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,17 @@ language: node_js
node_js:
- "6.10"

addons:
apt:
packages:
- openjdk-8-jdk
- maven
- rpm

before_script:
- npm install -g node-license-validator
- npm install -g semantic-release

script:
# Install npm dependencies
- "if [[ \"$TRAVIS_PULL_REQUEST\" = \"false\" && $TRAVIS_BRANCH =~ npm-publish-webapp-repo ]]; then npm install ; fi"
# Run tests
- "if [[ \"$TRAVIS_PULL_REQUEST\" = \"false\" && $TRAVIS_BRANCH =~ npm-publish-webapp-repo ]]; then npm run test ; fi"
# Validate npmjs licenses
- "if [[ \"$TRAVIS_PULL_REQUEST\" = \"false\" && $TRAVIS_BRANCH =~ dev ]]; then pushd integration-commons/src/main/webapp ; npm run license-check ; popd ; fi"
# Deploy to oss.sonatype.org
- "if [[ \"$TRAVIS_PULL_REQUEST\" = \"false\" && $TRAVIS_BRANCH =~ dev ]]; then mvn clean deploy --settings settings.xml ; fi"
- "if [[ \"$TRAVIS_PULL_REQUEST\" != \"false\" ]]; then mvn clean install ; fi"
- "if [[ \"$TRAVIS_PULL_REQUEST\" = \"false\" && $TRAVIS_BRANCH =~ npm-publish-webapp-repo ]]; then npm run license-check ; fi"

# Deploy to npmjs.org using semantic-release; make sure that NPM_TOKEN and GH_TOKEN are set on Travis settings
after_success: "if [[ \"$TRAVIS_PULL_REQUEST\" = \"false\" && $TRAVIS_BRANCH =~ dev ]]; then pushd integration-commons/src/main/webapp ; npm run semantic-release ; popd ; fi"
after_success: "if [[ \"$TRAVIS_PULL_REQUEST\" = \"false\" && $TRAVIS_BRANCH =~ npm-publish-webapp-repo ]]; then npm run semantic-release ; fi"
55 changes: 12 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,26 @@
[![Symphony Software Foundation - Incubating](https://cdn.rawgit.com/symphonyoss/contrib-toolbox/master/images/ssf-badge-incubating.svg)](https://symphonyoss.atlassian.net/wiki/display/FM/Incubating) [![Build Status](https://travis-ci.org/symphonyoss/App-Integrations-Commons.svg?branch=dev)](https://travis-ci.org/symphonyoss/App-Integrations-Commons)

# Integrations Commons Documentation
# Integrations Front-End Commons Documentation

This document provides a brief overview of Integration Commons components and how to build them from scratch.
This document provides a brief overview of Integration Front-End Commons components and how to build and publish them.

# Overview

Integration Commons provides the common components required to build a new integration to Symphony Platform, as the common base class for any WebHook based integration, Symphony authentication utility classes, metrics tools, and many other utility classes.
Integration FE Commons provides the common components required to build a configurator application for Symphony Platform integrations, such as room search, webhook creation, webhook editing etc.

The third-party services that would like to post messages into a configurable set of streams should define the integration-parent as a parent of your maven project.

Example:

```
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>integration-parent</artifactId>
<groupId>org.symphonyoss</groupId>
<version>0.10.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>integration-test</artifactId>
<dependencies>
<dependency>
<groupId>org.symphonyoss.symphony.integrations</groupId>
<artifactId>integration-webhook</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
</project>
```

If you want to create a new webhook integration you should define the __integration-webhook__ module as a dependency and start by extending the [WebHookIntegration](integration-webhook/src/main/java/org/symphonyoss/integration/webhook/WebHookIntegration.java) class, as it is the super class of every other integration.

# Installation instructions for the Java developer
# Installation instructions for the Javasctipt developer

### What you’ll build
You’ll build a simple java library that provides some useful services to build new integrations.
You’ll build a simple Javascript library that provides some useful services to build new configurator apps for integrations.

### What you’ll need
* JDK 1.7
* Maven 3.0.5+

### Build with maven
Integration Commons is compatible with Apache Maven 3.0.5 or above. If you don’t already have Maven installed you can follow the instructions at maven.apache.org.
* Nodejs 6.10
* NPM node-license-validator
* NPM semantic-release

### Build with NPM
To start from scratch, do the following:

1. Clone the source repository using Git: `git clone git@github.com:symphonyoss/App-Integrations-Commons.git`
2. cd into _App-Integrations-Commons_
3. Build using maven: `mvn clean install`
1. Clone the source repository using Git: `git clone git@github.com:symphonyoss/App-Integrations-FE-Commons.git`
2. cd into _App-Integrations-FE-Commons_
3. Build using npm: `npm install`
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"test:watch": "npm test -- --watch",
"watch": "webpack-dev-server --progress --colors --hot --inline --https",
"semantic-release": "semantic-release pre && npm publish && semantic-release post",
"license-check": "node-license-validator --allow-licenses WTFPL Apache Apache-2 BSD-like BSD BSD-2-Clause BSD-3-Clause Apache-2.0 MIT ISC Unlicense MIT/X11 \"MIT / http://rem.mit-license.org\" \"Public Domain\" --allow-packages domelementtype@1.3.0 domhandler@2.3.0 domutils@1.5.1 extsprintf@1.0.2 ripemd160@0.2.0 rx-lite@3.1.2 shellwords@0.1.0 stream-cache@0.0.2 verror@1.3.6"
"license-check": "node-license-validator --allow-licenses WTFPL Apache Apache-2 BSD-like BSD BSD-2-Clause BSD-3-Clause Apache-2.0 MIT ISC Unlicense MIT/X11 \"MIT / http://rem.mit-license.org\" \"Public Domain\" --allow-packages map-stream@0.1.0 domelementtype@1.3.0 domhandler@2.3.0 domutils@1.5.1 extsprintf@1.0.2 ripemd160@0.2.0 rx-lite@3.1.2 shellwords@0.1.0 stream-cache@0.0.2 verror@1.3.6"
},
"jest": {
"transform": {
Expand Down

0 comments on commit 09662e2

Please sign in to comment.