Skip to content
This repository has been archived by the owner on Mar 24, 2019. It is now read-only.

Commit

Permalink
fix: added automated release and doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
maoo committed Oct 24, 2018
1 parent ea7edd0 commit 33a1575
Show file tree
Hide file tree
Showing 7 changed files with 176 additions and 49 deletions.
43 changes: 43 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
language: node_js
node_js:
- 8

env:
global:
# travis encrypt GITHUB_USERNAME=....
# travis encrypt GITHUB_PASSWORD=....
# travis encrypt GH_TOKEN=....
# travis encrypt NPM_TOKEN=...
# - secure: ""


deploy:
# TODO - enable it when ready to release
- provider: script
skip_cleanup: true
script: npm run semantic-release
on:
branch: docs-pages
- provider: script
skip_cleanup: true
# TODO - replace maoo/fdc3-pages-layout with FDC3/FDC3, as soon as code is contributed
script: curl https://raw.githubusercontent.com/maoo/FDC3/common-docs-layout/docs/prepare-docs-release.sh | bash
on:
branch: docs-pages
- provider: pages
skip-cleanup: true
github-token: $GH_TOKEN
email: $GITHUB_EMAIL
name: $GITHUB_USERNAME
verbose: true
keep-history: true
local-dir: gh-pages-docs
target_branch: gh-pages
on:
branch: docs-pages

# TODO - enable it when ready to release
# notifications:
# email:
# - fdc3-intents@finos.org
# - announce@finos.org
51 changes: 2 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,5 @@
# Intents
FDC3 Intents specifications, schemas, and examples

* Extending APIs from one App to another is powerful...
* However, it requires building to a specific API ahead of time
* Standard context and intent definitions let us create workflows on the fly
FDC3 Intents specifications, schemas, and examples.

FDC3 Intents define a standard set of verbs that can be used to put together common cross-application workflows on the financial desktop.
* Applications register the intents & context combination they support
* The registries support app discovery by intents and/or context
* Intents are not full RPC, Apps don’t need to enumerate every function with an intent
* FDC3 Standard intents are a limited set, organizations can create their own intents

## Using Intents
Combined with FDC3 Context Data and App Directory standards, Intents enable rich service discovery on the the desktop. For example:

**Directing a market data platform to show a chart**
```javascript
fdc3.open("my-platform","ViewChart",{
object:"fdc3-context",
version:"0.0.1",
definition:"https://fdc3/schema/context/0.0.1",
data:[
{
type:"instrument",
name:"IBM",
id:{
ticker:"ibm"
}
} ]});
```

**Discovering an app that can start a chat**
```javascript
fdc3.open(null,"StartChat",{
object:"fdc3-context",
version:"0.0.1",
definition:"https://fdc3/schema/context/0.0.1",
data:[
{
type:"contact",
name:"Nick Kolba",
id:{
email:"nick@openfin.co"
}
} ]});
```

**Discovering apps that have intents for context type "contact"**
```javascript
let availableContactHandlers = fdc3.resolve(null,"contact");
```
Visit [fdc3-intents.finos.org](https://fdc3-intents.finos.org) for more info.
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fdc3-intents.finos.org
33 changes: 33 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
title: FDC3 Intents specifications

description: The documentation website for the FINOS FDC3 Intents specifications

google_analytics: UU-123456

show_downloads: false

github:
is_project_page: true
repository_url: https://github.com/fdc3/Intents

version: '[[tag]]'

collections:
- tags

links:
- name: Getting Started
url: /
- name: API specs
url: /specs
- name: FDC3 ContextData Working Group
url: https://finosfoundation.atlassian.net/wiki/spaces/FDC3/pages/85393412/Context+Data+Working+Group
target: _blank

social_icons:
- name: github
image_url: "https://www.finos.org/hs-fs/hubfs/FINOS/website/logos/social-logos/github-logo-black.png?t=1539813516681&width=48&height=48&name=github-logo.png"
link_url: https://github.com/fdc3/Intents
- name: confluence
image_url: "https://www.finos.org/hs-fs/hubfs/sofin%20assets/External%20logos/atlassian-logo.png?width=48&height=48&name=atlassian-logo.png"
link_url: https://finosfoundation.atlassian.net/wiki/spaces/FDC3/pages/83984435/Intents+Working+Group
57 changes: 57 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
layout: default
---

# Intents

FDC3 Intents specifications, schemas, and examples.

* Extending APIs from one App to another is powerful...
* However, it requires building to a specific API ahead of time
* Standard context and intent definitions let us create workflows on the fly

FDC3 Intents define a standard set of verbs that can be used to put together common cross-application workflows on the financial desktop.
* Applications register the intents & context combination they support
* The registries support app discovery by intents and/or context
* Intents are not full RPC, Apps don’t need to enumerate every function with an intent
* FDC3 Standard intents are a limited set, organizations can create their own intents

## Using Intents
Combined with FDC3 Context Data and App Directory standards, Intents enable rich service discovery on the the desktop. For example:

**Directing a market data platform to show a chart**
```javascript
fdc3.open("my-platform","ViewChart",{
object:"fdc3-context",
version:"0.0.1",
definition:"https://fdc3/schema/context/0.0.1",
data:[
{
type:"instrument",
name:"IBM",
id:{
ticker:"ibm"
}
} ]});
```

**Discovering an app that can start a chat**
```javascript
fdc3.open(null,"StartChat",{
object:"fdc3-context",
version:"0.0.1",
definition:"https://fdc3/schema/context/0.0.1",
data:[
{
type:"contact",
name:"Nick Kolba",
id:{
email:"nick@openfin.co"
}
} ]});
```

**Discovering apps that have intents for context type "contact"**
```javascript
let availableContactHandlers = fdc3.resolve(null,"contact");
```
5 changes: 5 additions & 0 deletions Specification-Draft.MD → docs/specs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
layout: default
---

# FDC3 Intents Specification - Draft #

## FDC3 Intents Overview ##
FDC3 Intents define a standard set of nouns and verbs that can be used to put together common cross-application workflows on the financial desktop.

Expand Down
35 changes: 35 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"name": "fdc3-intents",
"main": "index.js",
"repository": "https://github.com/maoo/Intents.git",
"license": "Apache-2.0",
"scripts": {
"semantic-release": "semantic-release"
},
"devDependencies": {
"semantic-release": "^15.10.3",
"@semantic-release/changelog": "^3.0.1",
"@semantic-release/git": "^7.0.5"
},
"release": {
"branch": "docs-pages",
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/git",
[
"@semantic-release/changelog",
{
"changelogFile": "docs/CHANGELOG.md.new"
}
],
[
"@semantic-release/npm",
{
"npmPublish": false
}
],
"@semantic-release/github"
]
}
}

0 comments on commit 33a1575

Please sign in to comment.