From b7af89b39f25ee573f7231301e848ee0dfd18d9e Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Thu, 14 Dec 2017 00:00:59 +0000 Subject: [PATCH] Deploy website Deploy website version based on fa9edb266c14170e6a46dc9c809a2adbd92b056c --- docs/en/publishing.html | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/en/publishing.html b/docs/en/publishing.html index 3577534792..fee0aa8baf 100644 --- a/docs/en/publishing.html +++ b/docs/en/publishing.html @@ -65,27 +65,23 @@
  • Create a new environment variable named "GITHUB_TOKEN", using your newly generated access token as the value.
  • Open your circle.yml file and add the following under the machine: section to tell Circle to use relatively recent versions of node and npm, replacing npm with yarn if applicable:
  • -
    ```
    -machine:
    -  node:
    -    version: 6.11.2
    +
    machine:
    +  node:
    +    version: 6.11.2
       npm:
    -    version: 3.10.10
    -```
    +    version: 3.10.10
     
    1. Then, add the following lines to the deployment: section. If you don't have a deployment: section, you can add it at the end of the file.
    -
    ```
    -deployment:
    +
    deployment:
       website:
         branch: master
         commands:
    -      - git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
    -      - git config --global user.name "<YOUR_NAME>"
    -      - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
    -      - cd website && npm install && GIT_USER=<GIT_USER> npm run publish-gh-pages
    -```
    +      - git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
    +      - git config --global user.name "<YOUR_NAME>"
    +      - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
    +      - cd website && npm install && GIT_USER=<GIT_USER> npm run publish-gh-pages
     

    Make sure to replace <GIT_USER> with the actual username of the GitHub account that will be used to publish the documentation.

    DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.