Merge pull request UiPath#37 from UiPath/feature/autodeploy_docs

Feature / publish docs automatically on master builds

Author: vladjerca

.build/commitlint/index.js

@@ -5,18 +5,13 @@ const Octokit = require('@octokit/rest')
 const { lint, load } = require('@commitlint/core')
 const path = require('path')
 
-const ACCESS_TOKEN = process.env['GH_STATUS_TOKEN']
-
-if (!ACCESS_TOKEN) throw new Error('No access token found. env: GH_STATUS_TOKEN')
+const { variables } = require('../common')
+const { owner, repo, pull, token } = variables;
 
 const github = new Octokit({
-    auth: ACCESS_TOKEN,
+    auth: token,
 })
 
-const owner = process.env['GH_OWNER']
-const repo = process.env['GH_REPO']
-const pull = process.env['GH_PULL_ID']
-
 const _handleUnexpectedError = (err) => {
     console.error(err)
     process.exit(1)

.build/common/index.js

@@ -0,0 +1,21 @@
+const extract = (token) => {
+    const value = process.env[token]
+    if (!value) throw new Error(`Could not read environment variable: ${token}`)
+
+    return value;
+}
+const owner = extract('GH_OWNER')
+const repo = extract('GH_REPO')
+const pull = extract('GH_PULL_ID')
+const token = extract('GH_TOKEN')
+
+const variables = {
+    owner,
+    repo,
+    pull,
+    token,
+}
+
+module.exports = {
+    variables,
+}

.build/publish-gh-pages.js

@@ -0,0 +1,21 @@
+const ghpages = require('gh-pages')
+const { variables } = require('../common')
+const { owner, repo, token } = variables;
+
+const PUBLISH_CONFIG = {
+    repo: `https://${token}@github.com/${owner}/${repo}.git`,
+    silent: true,
+}
+
+console.log('Publishing docs to branch `gh-pages`...')
+
+ghpages.publish(
+    'documentation',
+    PUBLISH_CONFIG,
+    (err) => {
+        if (err) {
+            console.error(err)
+        } else {
+            console.log('Docs have been published succesfully...')
+        }
+    })

.build/publish-gh-pages/index.js

@@ -3,7 +3,7 @@ steps:
       echo '##vso[task.setvariable variable=CC_TEST_REPORTER_ID]$(system.ccToken)'
       echo '##vso[task.setvariable variable=GIT_COMMIT_SHA]$(Build.SourceVersion)'
       echo '##vso[task.setvariable variable=GIT_BRANCH]$(Build.SourceBranchName)'
-      echo '##vso[task.setvariable variable=GH_STATUS_TOKEN]$(system.githubStatusToken)'
+      echo '##vso[task.setvariable variable=GH_TOKEN]$(system.githubToken)'
       echo '##vso[task.setvariable variable=GH_PULL_ID]$(System.PullRequest.PullRequestNumber)'
       echo '##vso[task.setvariable variable=GH_OWNER]UiPath'
       echo '##vso[task.setvariable variable=GH_REPO]angular-components'

.ci/templates/steps/initialize-environment.yml

@@ -44,3 +44,19 @@ jobs:
     dependsOn:
       - CommitLint
     condition: succeeded('CommitLint')
+
+  - job: Documentation
+    pool :
+      vmImage: 'ubuntu-latest'
+    steps:
+      - template: .ci/templates/steps/initialize-environment.yml
+      - template: .ci/templates/steps/install-dependencies.yml
+      - script: |
+          npm run docs
+        displayName: 'Generating Docs'
+      - script: |
+          git config user.email [email protected]
+          git config user.name "Azure Pipelines"
+          node .build/publish-gh-pages
+        displayName: 'Publishing Docs'
+    condition: eq(variables['Build.SourceBranchName'], 'master')

azure-pipelines.yml

@@ -38,8 +38,6 @@
     "e2e": "ng e2e",
     "package": "npm-run-all build:prod",
     "docs": "compodoc",
-    "predocs:publish": "npm run docs",
-    "docs:publish": "node ./.build/publish-gh-pages.js",
     "commit": "git-cz"
   },
   "config": {