[FABCN-378] Publish jsdoc

Signed-off-by: James Taylor <jamest@uk.ibm.com>

Author: jt-nti

.gitignore

@@ -21,8 +21,6 @@ tools/toolchain/network/crypto-material/*.tx
 tools/toolchain/network/crypto-material/crypto-config
 tools/toolchain/network/crypto-material/core.yaml
 
-docs/**/_out
-
 # Rush files
 common/temp/**
 **/.rush/temp/**
@@ -32,3 +30,6 @@ common/temp/**
 package-deps.json
 test-results.xml
 docker.log
+
+# jsdoc output
+docs/gen

README.md

@@ -1,28 +1,34 @@
 # Hyperledger Fabric - Node.js Contracts
 
-This is the project to support the writing of Contracts with the node.js runtime. 
+[![Build Status](https://dev.azure.com/Hyperledger/Fabric-Chaincode-Node/_apis/build/status/Fabric-Chaincode-Node?branchName=master)](https://dev.azure.com/Hyperledger/Fabric-Chaincode-Node/_build/latest?definitionId=33&branchName=master)
+[![fabric-contract-api npm module](https://img.shields.io/npm/v/fabric-shim?label=fabric-contract-api)](https://www.npmjs.com/package/fabric-contract-api)
+[![fabric-shim npm module](https://img.shields.io/npm/v/fabric-shim?label=fabric-shim)](https://www.npmjs.com/package/fabric-shim)
+[![fabric-shim-api npm module](https://img.shields.io/npm/v/fabric-shim?label=fabric-shim-api)](https://www.npmjs.com/package/fabric-shim-api)
+[![fabric-shim-crypto npm module](https://img.shields.io/npm/v/fabric-shim?label=fabric-shim-crypto)](https://www.npmjs.com/package/fabric-shim-crypto)
+[![Rocket.Chat](https://chat.hyperledger.org/images/join-chat.svg)](https://chat.hyperledger.org/channel/fabric-chaincode-dev)
 
-As an application developer, to learn about how to implement **"Smart Contracts"** for Hyperledger Fabric using Node.js, please visit the [API documentation](https://fabric-shim.github.io/) - and follow the tutorial links. A [quick-start tutorial](TUTORIAL.md) is in this repo.
+This is the project to support the writing of Contracts with the node.js runtime. 
 
 As a contributor looking to update this repo, please start with the [contributing guide](CONTRIBUTING.md)
 
+## Documentation
+
+As an application developer, to learn about how to implement **"Smart Contracts"** for Hyperledger Fabric using Node.js, please visit the [API documentation](https://hyperledger.github.io/fabric-chaincode-node/) and follow the tutorial links.
+
+- [API documentation](https://hyperledger.github.io/fabric-chaincode-node/)
+- [Full Documenation on Hyperledger Fabric](https://hyperledger-fabric.readthedocs.io/)
+- [Samples repository](https://github.com/hyperledger/fabric-samples)
+- [Quick-start tutorial](TUTORIAL.md)
+
 ## Artifacts published from this repo
 
 - npm modules
-    - [fabric-chaincode-shim](https://www.npmjs.com/package/fabric-chaincode-shim)
     - [fabric-contract-api](https://www.npmjs.com/package/fabric-contract-api)
+    - [fabric-shim](https://www.npmjs.com/package/fabric-shim)
     - [fabric-shim-api](https://www.npmjs.com/package/fabric-shim-api)
     - [fabric-shim-crypto](https://www.npmjs.com/package/fabric-shim-crypto)
 - docker images
     - [fabric-nodeenv](https://hub.docker.com/r/hyperledger/fabric-nodeenv)
-- api documentation
-    - [API docs](https://fabric-shim.github.io/)    
-
-## Where to go from here?
-
-- [API documentation](https://fabric-shim.github.io/)
-- [Full Documenation on Hyperledger Fabric](https://hyperledger-fabric.readthedocs.io/en/release-1.4/)
-- [Samples repository](https://github.com/hyperledger/fabric-samples)
 
 ---
 

ci/azure-pipelines.yml

@@ -99,11 +99,6 @@ stages:
               inputs:
                 pathToPublish:  $(Build.ArtifactStagingDirectory)/logs
                 artifactName: 'Build logs'
-            - task: PublishBuildArtifacts@1
-              condition: or(succeeded(), failed())   # publish either way
-              inputs:
-                pathToPublish: docs/apidocs/_out
-                artifactName: 'JS API Doc'
 
             # Copy the built artifacts to the staging directory, tgz, and the docker image
             - script: |
@@ -200,6 +195,61 @@ stages:
                 npm audit
               displayName: 'Run npm audit'
 
+        # Build and publish API docs on every merge build
+        - job: jsdoc
+          condition: and(succeeded(),eq(variables['Build.Reason'], 'IndividualCI'))
+          steps:
+            - script: |
+                set -ev
+                node common/scripts/install-run-rush.js install
+              displayName: 'Setup the rush environment'
+            - script: |
+                set -ev
+                node common/scripts/install-run-rush.js rebuild --to fabric-shim-docs
+              displayName: 'Build JSDoc'
+            - task: CopyFiles@2
+              inputs:
+                contents: |
+                  gen/**
+                sourceFolder: '$(Build.SourcesDirectory)/docs'
+                targetFolder: $(Build.ArtifactStagingDirectory)/jsdoc
+                cleanTargetFolder: true
+              displayName: 'Copy jsdoc'
+            - task: CopyFiles@2
+              condition: eq(variables['Build.SourceBranch'], 'refs/heads/master')
+              inputs:
+                contents: |
+                  _config.yml
+                  **/?(*.md|*.html)
+                  !_jsdoc.json
+                  !_jsdoc/**
+                sourceFolder: '$(Build.SourcesDirectory)/docs'
+                targetFolder: $(Build.ArtifactStagingDirectory)/gh-pages
+                cleanTargetFolder: true
+              displayName: 'Copy gh-pages doc (master branch only)'
+            - script: |
+                git reset --hard HEAD
+                git clean -xdf
+                git fetch origin
+                git checkout -b gh-pages origin/gh-pages
+                git clean -xdf
+
+                mkdir -p $(Build.SourceBranchName)/api
+                rm -rf $(Build.SourceBranchName)/api/*
+                cp -r $(Build.ArtifactStagingDirectory)/jsdoc/* $(Build.SourceBranchName)/api
+                if [ -d $(Build.ArtifactStagingDirectory)/gh-pages ]; then
+                  find . -maxdepth 1 ! \( -name [.]* -o -name 'gh-pages' -o -name 'master' -o -name 'release-*' \) -exec rm -rf {} \;
+                  cp -r $(Build.ArtifactStagingDirectory)/gh-pages/* .
+                fi
+              displayName: 'Update gh-pages branch'
+            - script: |
+                git config --global user.email "hlfdev.azp@gmail.com"
+                git config --global user.name "Hyperledger Bot"
+                git add -A
+                git commit -m "Publishing GitHub Pages"
+                git push https://$(GITHUB-PAT)@github.com/hyperledger/fabric-chaincode-java.git gh-pages
+              displayName: 'Commit gh-pages changes'
+
     # Publish a new version, triggered by a git tag
     - stage: Publish_tag
       dependsOn: Build_and_Test