Fix: Use webhint before deploying to production

Fix #51
Close #487

Author: molant

.hintrc

@@ -0,0 +1,28 @@
+{
+    "extends": [
+        "web-recommended"
+    ],
+    "ignoredUrls": [
+        {
+            "domain": "^https?://cdn\\.jsdelivr\\.net/.*",
+            "hints": [
+                "*"
+            ]
+        },
+        {
+            "domain": "^https?://.*\\.google-analytics\\.com/.*",
+            "hints": [
+                "*"
+            ]
+        },
+        {
+            "domain": "^https?://fonts\\.googleapis\\.com/.*",
+            "hints": [
+                "*"
+            ]
+        }
+    ],
+    "hints": {
+        "html-checker": "off"
+    }
+}

.travis.yml

@@ -3,17 +3,30 @@
 #
 # https://docs.travis-ci.com
 
-after_success:
-  - npm run travis-update
-
 env:
   global:
 
     # DOC_SEARCH_ID & DOC_SEARCH_KEY
     - secure: "Jjq86BkxLcYQcw8V12p01Jd+X9pZD4aZL8ILzGFp0FBEqJRtgpIJe57Z5zB/gkZxAfrgZxKW3SaFMy8OizGPnA7xO0AYyH/KDv3P/xGlGbV8VtAHLvrA/WI2NNZSQf8c+UEBqK4ZiXrbkI62xlEED6WxRrqXSBGhYKZhXI7EsCSxdMW6+19IeiolNSpKL3CExglS7p7UzGSE+BIRZWmo5ya4bMkahR2Q5yoY3wAc2FKb4KWCH55bF/0crRDbCAw5Nvp1YVGT2EnHuBHck0Z5Hwy+/5LUOYB3uLNXUqfsRRkIQA653/01l18BNCQfO2mtFeNKjah51+BoZkMUAo4+1ebWTt0R0l5M3qKfrjUDxD8FJNYLMx20Vx8xx1LRrQzwXagB7J8OZ8LciYcbJWH86nQnSI9AOAQgc7f07CM/alTq2b8sPY1rgf9l8rx2Sj+jgPsFOlNOrYxQnQSLtiEjepAoYaW0a/FLyWBSyVXYgi6QpVGbv2OOCJl+9bcZUY+P8KynN1jwrmXv2eTDCwpy/5y4Uw6+4s7p/p5CyfboMZZ0Qq6dk4r3QlWr+tw7eGwmEswS93J3D58CjpMStlxEygDFA9gV8Y72woQAV2VbS7DjDsYsD4+W7FIfSqdL8ATj/hOrSUkyQJAAtsDSmVo/pc8+KRBOuc5G7rbaCKpN9J4="
 
-    # GH_USER_EMAIL & GH_USER_NAME
-    - secure: "eFYQUR5b7vA7Q/kLiabHG5Qldy024n3ARdcEY+vVWMOWi1dAbxFj9/gv0qIxkxzsSdr6yUmG6gjfusows3BbJP56SttFambN5WQcv1gK3m/urtC2v1fFMkKAAd1eDgEkEQXZRN8TeqXpu1RPyYctUiSm6JZ82ah0vNxPXJ9+E3nMv76Ok/tJ2DOO7BUMb4GXGxa0G9lta/M5LHiHMB9IP5vePEO02IrbAzXYgBrLlUp5LwPpugLvijR1gYo+NQvgUy2Zyo5t9YhNAQPfps/C3OfyRHvIc2+hZE12xtBE1M1iTOFBuCKmT9BInbq6tTbjJLOIyaFgfV2So/H0yiegilyFfazqeRN3sVCanUiG7jB2cPQlLvxwjRZvuWXD5uhSwiImzMSmzEEfLDydBj5ZQf941scH1h0s716DHV0G6wsQvu2LZeWrGsz+Mn5ApYKCnd9Ifa9K2mQ5k4JkUzh850PIjzwQE2THYW4uhHcdXgwpoWlQjIqbXue0paYxbgGaXS0IwLNw3sUfh3hIRQmxuPFxvwzD4+NkmxhjvUpAxgPD0t8tvrhhgpPeZ+c5IXKRdOA0jdtzSR9JB1l2CigmTu9gIeTqImGLNaA8pmfvUK0VS5r5jRcsFVDttZ1B745lC2t1vt9LlMJa5xUFehF6bzi9MS6VNo4+aOcc32vkKSc="
+    # AZURE_WA_USERNAME, AZURE_WA_PASSWORD, AZURE_WA_SITE, AZURE_WA_SLOT
+    - secure: "Bx6tfqQJYjlSofs3wEr2iqWx75HuR+Qtybomc97ueGxlkHjCXKF2A7one9ykwm+EVdJGVPLKM4bvS2ebqeNSPFSNyZbajXLV24lXgXsA3UVsXI3kBDkKG/bouyuQWvCeYAKF1XSbQM3513XbYSDWCdO72IkB5E961nvKCkLcsvJ+WGeE+3YtigK8ThHlzcM9Twt22y7ZQa4Y429uR6I1tAYzYkp4XHG/SO0tb9SAdGDg+nwkpyXq50HG1DSYOU+Q2x+Hpebz7gg9VckBLslicWp7qVkCKRS9VQAlacTLTVfQopxjC3gy0uNYOSDOle7RRomi9uYs3u4TPdW5Q2mkQJuFv2j/zaU7/tOTV+JEEaexA1gDFCH9NANCAHkgTeBLVerMINfFDrlj7qjIEoPZfhS1wxWZIeNGa3jGqdOLj02jBjJYUWmhdcwh61DUnYmYoErU5f2fG/K6mfbAr6e9F7MsYWFB3Q2GGEwIIUQUBqCD+7J+r/7CZoItqdad6fzvUzbUzaI4UPPSjhQJqApYF+XDfgeiFe24OmQtvUjHF/Ic7jeTwhAVXviAAbO29w8IuYX95XoOZBzDAJ8xXmdlvV2JHPhlmde18Bd3Q0Q7TlkKx/D8Ok+Cfx3o9Z4BRcfKfr75Ivc9gBZ3pWAocwS1uXCS2C0C+kmb6toSq5ffsq8="
+
+    # AZURE_SERVICE_PRINCIPAL, AZURE_SERVICE_PRINCIPAL_PASSWORD, AZURE_TENANT
+    - secure: "X/QMPB9/T31/sVQdiuzAgMlK2/Cc4koyom/CH1yUVyL+u8zYj4N+GF2yrI+aH0nw5LjgN44ENvz5Of945MGGpGiCYCXRzuZZhitQrfGVoW/97je6P0TrcCMzMtluBRs6gvq7XkWyl7hIUsYvFBnUiyr7AhdrN5OHYzbKJuuyB4T0EefyCfDyyKcytEiUlfaIyXa1TOOraEso4t9ghp+54kcUwrNTGtSUiDIy/XBb9PQkf2nJobm2O1F1b+UJvyHURWB4LOv758q8Apc/MIo7NSbSgOODCMQaRVPn1m3ZD+8EsAfNjjeSOO4OZlTO/tr1EzC/zv0Ib7czdtsDAEjDqkr3naKg2BCF1HHDYQ7alH7FOIA8cz8EKgmBx7keYnUaWVucX2gHsEZCMo0cPaUJxHAWhEekPG2iswzbvZhdWHdQdH9+GTUtN5r6oCL0MNDMHT04C2IgWHR8DFlT9kTDz4eojc3pjoU+pciWDRXC8NATM6orJrG7cAII9/queBlTVfa+BTtyHbL8jiHHQmEDnv3TwE/DIYY3Nwf2Zaw9YL/nPlKtEqQKl49dE51gYfT/BhzO8c3nRjOH6Vwep289H5IIQhfyTCilzV6wnFDu06iiINDpveP350LMQKNbPNHySJVBFdbSS88sAjorFbfpX0lqUFB07i/sjbQkZwwmP+U="
+
+    # GIT_USER_EMAIL, GIT_USER_NAME, GIT_PASSWORD
+    - secure: "OINn8LhTK6hTngwlxjum3k6Zuh08vfqSFbVhkNZnE9VlSZ+B3my1mmVSQYYBfo3lZXfEtiFuweVOIR/1Eh6FUK5r5+dGrNdg61I8eOhY4iVpNmaePTp6CdcHduVWAYolJEcbb//45FlLZAbEDXPVClg1By2fgOqg6RMHxIOZwSb4SFKCq4EXqjS3LNYhxUva+pUGhxxp1fEcX/vBz38HYar+JpSqZ/WO19RPaYOdXBfPCCLIgEYvtrEylupRVKybqL9rCzY1dZ9lipdrtm4Whs141RqHj7yxg1iyA+Qa9T9NqTOilVl349W9Bf24mt5p58iP0h3zc3HWK197Kwf8EJsSat5CnzXRRGM636FrrxlYol6QKyEa7IDolvJVryKT5mOE/2rwdPkdfteXm3IK3h49hniXR72eNO5oNFaNsrKp6w+LM4mu4q3XxXdloJr+26wc1BptRRU4XJrg4Qvdlx19ALkbu93mo1eW+aabKJeAnMj53LV7h4JSQqITP/DQWJRaKu9Zu4JHQHsZ4VnoyOqvf+OojO4fpWs/2YnyxIeOMYDB5EScBPljWPF2BDQFwqaJDN5DZegLWXx6XssZ2ObryfHPUNAlZ0spU5Jb0+O84LVvgf0RIgwIAChZww/I27/EFdcwt9woVdvRi/ViinydbZHa9vyUA9imG2NSRMo="
+
+script:
+  - npm test
+
+after_success:
+  - npm run travis-update
+  - npm run test-staging
+
+after_script:
+  - npm run swap
 
 language: node_js
 

.travis/swap.sh

@@ -0,0 +1,23 @@
+# Add the Azue CLI 2.0 source and install
+# https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-apt?view=azure-cli-latest
+AZ_REPO=$(lsb_release -cs)
+echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ $AZ_REPO main" | \
+    sudo tee /etc/apt/sources.list.d/azure-cli.list
+
+curl -L https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
+
+sudo apt-get install apt-transport-https
+sudo apt-get update && sudo apt-get install azure-cli
+
+# Use a scoped service principal to access Azure
+az login --service-principal -u $AZURE_SERVICE_PRINCIPAL -p $AZURE_SERVICE_PRINCIPAL_PASSWORD --tenant $AZURE_TENANT
+
+# Swap slots, default is production
+az webapp deployment slot swap -g sonarwhal -n sonarwhal --slot staging
+
+# Run the DocSearch scraper only is this is a cron job.
+# https://docs.travis-ci.com/user/cron-jobs/
+
+if [ "$TRAVIS_EVENT_TYPE" == "cron" ]; then
+    npm run travis-docsearch-scraper
+fi

.travis/update-site.sh

@@ -20,39 +20,31 @@ prepare_site_dist_dir() {
     done
 }
 
-run_docsearch_scraper() {
-
-    # Run the DocSearch scraper only is this is a cron job.
-    # https://docs.travis-ci.com/user/cron-jobs/
-
-    if [ "$TRAVIS_EVENT_TYPE" == "cron" ]; then
-        npm run travis-docsearch-scraper
-    fi
-
+update_website() {
+    # Move to temp folder
+    cd "$TMP_DIR"
+
+    git config --global user.email "$GIT_USER_EMAIL" \
+        && git config --global user.name "$GIT_USER_NAME" \
+        && git init \
+        && git add -A \
+        && git commit --message "Hey server, this content is for you! [skip ci]" \
+        && git push --quiet --force --set-upstream "https://$GIT_USER_NAME:$GIT_PASSWORD@sonarwhal-staging.scm.azurewebsites.net:443/sonarwhal.git" master
 }
 
-set_up_ssh() {
-    $(npm bin)/set-up-ssh \
-        --key "$encrypted_1b2b8f95b98b_key" \
-        --iv  "$encrypted_1b2b8f95b98b_iv" \
-        --path-encrypted-key ".travis/github-deploy-key.enc"
-}
+remove_sensitive_information() {
 
-update_website_branch() {
+    declare -r CENSOR_TEXT="[secure]";
 
-    # Automatically update the content from the `website` branch.
-    #
-    # Note: The SSH key is stored on Travis CI, but will need to be
-    #       added once the project is open sourced.
-    #
-    #       https://docs.travis-ci.com/user/private-dependencies/
+    while IFS="" read -r line; do
 
+        for text in "$@"; do
+            line="${line//${text}/$CENSOR_TEXT}"
+        done
 
-    "$(npm bin)/update-branch" --commands "echo" \
-                               --commit-message "Hey server, this content is for you! [skip ci]" \
-                               --directory "$TMP_DIR" \
-                               --distribution-branch "website" \
-                               --source-branch "master"
+        printf "%s\n" "$line"
+
+    done
 
 }
 
@@ -71,12 +63,14 @@ fi
 
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
-declare -r TMP_DIR="$(mktemp -d XXXXX)"
+main () {
+    declare -r TMP_DIR="$(mktemp -d XXXXX)"
 
-run_docsearch_scraper
+    prepare_site_dist_dir \
+        && update_website
 
-set_up_ssh \
-    && prepare_site_dist_dir \
-    && update_website_branch
+    rm -rf "$TMP_DIR"
+}
 
-rm -rf "$TMP_DIR"
+main "$@" \
+    &> >(remove_sensitive_information "$GH_USER_EMAIL" "$GIT_USER_NAME" "$GIT_PASSWORD")

architecture/server.md

@@ -63,12 +63,12 @@ The deployment process is fully automated:
 
 1. `master` branch build is triggered in [Travis][travis] (e.g. by code
    or documentation change).
-1. build passes and executes [`.travis/update-site.sh`][site-update].
-   This script will copy the required files for the deployment to the
-   `website` branch.
-1. Azure App Service is configured for [continuous deployment][cd] from
-   a GitHub source. Once it receives the notification the content is
-   automatically downloaded and published.
+1. build passes and executes `.travis/update-site.sh`.
+   This script will copy the required files for the deployment and push
+   them into a local Git on Azure in the staging environment.
+1. The staging environment will be tested with `webhint` to make sure
+   everything is alrigh. If so, the code will get into production via
+   `.travis/swap.sh`.
 
 ## Production configuration
 
@@ -159,9 +159,9 @@ IIS manages the custom error page via the following entries in `web.config`:
 [hexo]: https://hexo.io
 [letsencrypt install]: https://github.com/sjkp/letsencrypt-siteextension/wiki/How-to-install
 [letsencrypt]: https://letsencrypt.org
-[site-update]: https://github.com/webhintio/webhint.io/blob/272a59c150a6462d4047bdc63019c339fcfaead0/.travis/update-site.sh
 [siteextenstion]: https://github.com/sjkp/letsencrypt-siteextension
 [webhint]: https://webhint.io
 [webhint-repo]: https://github.com/webhintio/hint
 [travis]: https://travis-ci.org/webhint/webhint.io
 [trigger-update]: https://github.com/webhintio/hint/blob/0cfb1bb49c847eb4d5ed54691dbb88cb796694bf/.travis/trigger-site-update.sh
+