Visit the documentation website for more info.
The FDC3 API is released under the FINOS NPMJS Organisation (currently npmjs.com/org/symphonyoss - in transition to npmjs.com/org/finos).
On every commit, semantic release will be executed by Travis CI and - based on the commit message - will decide to trigger a release or not.
A release consists of:
- A version
- A
CHANGELOG.mdfile - A tag on GitHub
- An new NPM package version (published on
npmjs.org/org/finos)
Travis CI must be configured with the following environment variables:
GH_TOKEN, used to create tags on GitHubNPM_TOKEN, used to publish the npm package
You can setup variables using semantic-release-cli, Travis Repository Settings or with the travis CLI.
Semantic release allows additional configurations to customise the release flow.
To run the website documentation locally, please follow the steps below.
It is strongly advised to use RVM or RBenv to install Ruby; below are the steps to install RVM on MacOS.
mkdir -p ~/.rvm/src && cd ~/.rvm/src && rm -rf ./rvm && \
git clone --depth 1 https://github.com/rvm/rvm.git && \
cd rvm && ./install
rvm install 2.5.2
which bundle #Should return a .rvm sub-path
which ruby #Should return a .rvm sub-path
cd /tmp
git clone https://github.com/pages-themes/slate
cd slate
rm -rf .bundle
./script/bootstrap
gem install jekyll-theme-slate
gem install jekyll-seo-tag
gem install jekyll-watch
cd ../API/docs
jekyll serve --incremental