🚢 Deploy!

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2
 jobs:
   npm-install:
     docker:
-      - image: shieldsio/shields-ci-node-8:0.0.2
+      - image: shieldsio/shields-ci-node-8:0.0.3
     working_directory: ~/repo
     steps:
       - checkout
@@ -33,7 +33,7 @@ jobs:
 
   main:
     docker:
-      - image: shieldsio/shields-ci-node-8:0.0.2
+      - image: shieldsio/shields-ci-node-8:0.0.3
     working_directory: ~/repo
     steps:
       - checkout
@@ -63,9 +63,9 @@ jobs:
             CI_PULL_REQUEST: ''
           command: greenkeeper-lockfile-upload
 
-  main@node-9:
+  main@node-latest:
     docker:
-      - image: shieldsio/shields-ci-node-9:0.0.2
+      - image: shieldsio/shields-ci-node-latest:0.0.3
     working_directory: ~/repo
     steps:
       - checkout
@@ -85,7 +85,7 @@ jobs:
 
   frontend:
     docker:
-      - image: shieldsio/shields-ci-node-8:0.0.2
+      - image: shieldsio/shields-ci-node-8:0.0.3
     working_directory: ~/repo
     steps:
       - checkout
@@ -105,7 +105,7 @@ jobs:
 
   services-pr:
     docker:
-      - image: shieldsio/shields-ci-node-8:0.0.2
+      - image: shieldsio/shields-ci-node-8:0.0.3
     working_directory: ~/repo
     steps:
       - checkout
@@ -137,9 +137,9 @@ jobs:
               echo 'This is not a pull request. Skipping.'
             fi
 
-  services-pr@node-9:
+  services-pr@node-latest:
     docker:
-      - image: shieldsio/shields-ci-node-9:0.0.2
+      - image: shieldsio/shields-ci-node-latest:0.0.3
     working_directory: ~/repo
     steps:
       - checkout
@@ -173,7 +173,7 @@ jobs:
 
   services-daily:
     docker:
-      - image: shieldsio/shields-ci-node-8:0.0.2
+      - image: shieldsio/shields-ci-node-8:0.0.3
     working_directory: ~/repo
     steps:
       - checkout
@@ -197,7 +197,7 @@ workflows:
       - main:
           requires:
             - npm-install
-      - main@node-9:
+      - main@node-latest:
           requires:
             - npm-install
       - frontend:
@@ -206,7 +206,7 @@ workflows:
       - services-pr:
           requires:
             - npm-install
-      - services-pr@node-9:
+      - services-pr@node-latest:
           requires:
             - npm-install
 

.circleci/images/node-9/Dockerfile → .circleci/images/node-latest/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:9
+FROM node:latest
 ADD .circleci/images/prepare-container.sh /root/prepare-container.sh
 RUN /root/prepare-container.sh
 RUN rm /root/prepare-container.sh

.github/probot.js

@@ -0,0 +1,8 @@
+on('pull_request.closed')
+  .filter(context => context.payload.pull_request.merged)
+  .filter(context => context.payload.pull_request.base.ref === 'master')
+  .comment(`This pull request was merged to [{{ pull_request.base.ref }}]({{ repository.html_url }}/tree/{{ pull_request.base.ref }}) branch. Now this change is waiting for deployment. 
+Deploys usually happen every few weeks. After deployment changes are copied to [gh-pages]({{ repository.html_url }}/tree/gh-pages) branch. 
+
+This badge displays deployment status:
+![](https://shields-deployment.now.sh/github/commit-status/{{ repository.full_name }}/gh-pages/{{ pull_request.merge_commit_sha }}.svg?label=deploy%20status)`)

.gitignore

@@ -89,3 +89,4 @@ typings/
 # Temporary build artifacts.
 /build
 .next
+badge-examples.json

CONTRIBUTING.md

@@ -86,7 +86,7 @@ There are three places to get help:
 Badge guidelines
 ----------------
 
-- The left-hand side of a badge should not advertize. It should be a *noun*
+- The left-hand side of a badge should not advertise. It should be a *noun*
   succinctly describing the meaning of the right-hand side.
 - Query parameters must be *declared by the service*. See `request-handler.js`.
 - Except for badges using the `social` style, logos should be *turned off by

Dockerfile

@@ -16,7 +16,7 @@ RUN npm run build
 RUN npm prune --production
 RUN npm cache clean --force
 
-CMD envsubst < secret.tpl.json > ./private/secret.json
-CMD node server
+CMD envsubst < secret.tpl.json > ./private/secret.json \
+ && node server
 
 EXPOSE 80

README.md

@@ -10,9 +10,9 @@
     <a href="https://circleci.com/gh/badges/shields/tree/master">
         <img src="https://img.shields.io/circleci/project/github/badges/shields.svg"
             alt="build status"></a>
-    <a href="https://github.com/badges/shields/commits/gh-pages">
-        <img src="https://img.shields.io/github/last-commit/badges/shields/gh-pages.svg?label=last%20deployed"
-            alt="last deployed"></a>
+    <a href="https://github.com/badges/shields/compare/gh-pages...master">
+        <img src="https://img.shields.io/github/commits-since/badges/shields/gh-pages.svg?label=commits%20to%20be%20deployed"
+            alt="commits to be deployed"></a>
     <a href="https://discord.gg/HjJCwm5">
         <img src="https://img.shields.io/discord/308323056592486420.svg?logo=discord"
             alt="chat on Discord"></a>

dangerfile.js

@@ -91,3 +91,29 @@ if (capitals.created || underscores.created) {
     '(dash-separated lowercase).',
   ].join(''));
 }
+
+const all_files = danger.git.created_files.concat(danger.git.modified_files);
+
+all_files.forEach(function(file) {
+  danger.git.diffForFile(file).then(function(diff) {
+    if (/\+.*assert[(.]/.test(diff.diff)) {
+      warn([
+        `Found 'assert' statement added in ${file}. `,
+        'Please ensure tests are written using Chai ',
+        '[expect syntax](http://chaijs.com/guide/styles/#expect)'
+      ].join(''));
+    }
+  });
+});
+
+all_files.forEach(function(file) {
+  if (/^services\/.+\/.+\.js$/.test(file) && file.endsWith('.js') && !file.endsWith('.tester.js')) {
+    const tester = file.replace('.js', '.tester.js');
+    if (all_files.indexOf(tester) == -1) {
+      warn([
+        `This PR modified ${file} but not ${tester}. `,
+        "That's okay so long as it's refactoring existing code.",
+      ].join(''));
+    }
+  }
+});

doc/TUTORIAL.md

@@ -109,7 +109,7 @@ This example is the for the Docker Hub automated integration. ([Source][docker-e
 
 ```js
 // Docker Hub automated integration.                                             // (1)
-camp.route(/^\/docker\/automated\/([^\/]+)\/([^\/]+)\.(svg|png|gif|jpg|json)$/,  // (2)
+camp.route(/^\/docker\/automated\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,    // (2)
 cache(function(data, match, sendBadge, request) {                                // (2)
   var user = match[1];  // eg, jrottenberg                                       // (3)
   var repo = match[2];  // eg, ffmpeg                                            // (3)
@@ -121,22 +121,21 @@ cache(function(data, match, sendBadge, request) {
   var url = 'https://registry.hub.docker.com/v2/repositories/' + path;           // (4)
   var badgeData = getBadgeData('docker build', data);                            // (5)
   request(url, function(err, res, buffer) {                                      // (6)
-    if (err != null) {                                                           // (7)
-      badgeData.text[1] = 'inaccessible';                                        // (7)
+    if (checkErrorResponse(badgeData, err, res, 'repo not found')) {             // (7)
       sendBadge(format, badgeData);                                              // (7)
       return;                                                                    // (7)
     }
     try {
-      var data = JSON.parse(buffer);                                             // (8)
-      var is_automated = data.is_automated;                                      // (8)
+      var parsedData = JSON.parse(buffer);                                       // (8)
+      var is_automated = parsedData.is_automated;                                // (8)
       if (is_automated) {
         badgeData.text[1] = 'automated';                                         // (9)
         badgeData.colorscheme = 'blue';                                          // (9)
       } else {
         badgeData.text[1] = 'manual';                                            // (9)
         badgeData.colorscheme = 'yellow';                                        // (9)
       }
-      badgeData.colorB = '#008bb8';                                              // (9)
+      badgeData.colorB = data.colorB || '#008bb8';                               // (9)
       sendBadge(format, badgeData);                                              // (9)
     } catch(e) {                                                                 // (10)
       badgeData.text[1] = 'invalid';                                             // (10)
@@ -154,11 +153,11 @@ The following numbering explains what happens in the corresponding lines.
    Usually, badges with a similar topic have their implementation close to each other's.
 2. The [regular expression][regex] matches the path behind the host name in the URL, e.g. `img.shields.io`.
    ```
-   /^\/docker\/automated\/([^\/]+)\/([^\/]+)\.(svg|png|gif|jpg|json)$/
-                                            \.(svg|png|gif|jpg|json)
-                                            The supported endings
-                                            e.g. ".svg"
-                          ([^\/]+)\/([^\/]+)
+   /^\/docker\/automated\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/
+                                          \.(svg|png|gif|jpg|json)
+                                          The supported endings
+                                          e.g. ".svg"
+                          ([^/]+)\/([^/]+)
                           The name of the repository
                           e.g. "jrottenberg/ffmpeg"
      \/docker\/automated\/
@@ -173,19 +172,23 @@ The following numbering explains what happens in the corresponding lines.
    The `url` is created to query the API.
 5. Create the basic badge to use.
    You can read about the [different formats available][format].
-   It contains the format for all responses, regarless of the API's response.
+   It contains the format for all responses, regardless of the API's response.
 6. We request the `url` and pass a call back function to the request.
    The function is called once the data is retrieved from the API.
 7. We want to always see a badge regardless the input.
-   In some cases the API may return an error e.g. if the query was invalid.
-   The error is handled and a badge with the the status "inaccessible" is returned.
-   ![](https://img.shields.io/badge/docker%20build-inaccessible-lightgrey.svg)
+   In some cases the API may return an error or a HTTP status code indicating
+   a client error or a server error e.g. if the query was invalid. The error response
+   is handled by the [checkErrorResponse](https://github.com/badges/shields/blob/8fcc13d5bced23f53c9f075e51b419060f6cc124/lib/error-helper.js#L8)
+   function and a badge with an appropriate status is returned: "inaccessible"
+   ![](https://img.shields.io/badge/docker_build-inaccessible-red.svg), "not found"
+   ![](https://img.shields.io/badge/docker_build-not_found-lightgrey.svg)
+   or "invalid" ![](https://img.shields.io/badge/docker_build-invalid-lightgrey.svg).
 8. The data returned by the API as JSON is parsed.
 9. Based on the result, the text and the color of the badge are altered.
    ![](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg)
    ![](https://img.shields.io/docker/automated/codersos/ubuntu-remix.svg)
 10. In case of an error, an "invalid" badge is constructed.
-    ![](https://img.shields.io/docker/automated/,/ubuntu-remix.svg)
+    ![](https://img.shields.io/badge/docker_build-invalid-lightgrey.svg)
 
 The pattern described can be found in may other badges.
 When you look at the [server.js][server], you find many other badges.
@@ -269,7 +272,7 @@ These files can also be of help for creating your own badge.
 [edit]: https://github.com/badges/shields/edit/master/doc/TUTORIAL.md
 [add-pr]: https://github.com/badges/shields/issues?utf8=%E2%9C%93&q=is%3Aissue%20in%3Atitle%20add%20
 [new-badge]: https://github.com/badges/shields/pulls?q=is%3Apr+label%3Anew-badge
-[docker-example]: https://github.com/badges/shields/blob/bf373d11cd522835f198b50b4e1719027a0a2184/server.js#L5014
-[travis-example]: https://github.com/badges/shields/blob/bf373d11cd522835f198b50b4e1719027a0a2184/server.js#L431
+[docker-example]: https://github.com/badges/shields/blob/b126b4ebdc64015a3d6e845d9c051f69ad81c4ea/server.js#L6275
+[travis-example]: https://github.com/badges/shields/blob/b126b4ebdc64015a3d6e845d9c051f69ad81c4ea/server.js#L403
 [regex]: https://www.w3schools.com/jsref/jsref_obj_regexp.asp
 [tests-tutorial]: ../service-tests/#readme

doc/gh-badges.md

@@ -22,8 +22,8 @@ The format is the following:
 
 ### See also
 
-- [colorscheme.json](lib/colorscheme.json) for the `colorscheme` option
-- [templates/](templates) for the `template` option
+- [colorscheme.json](../lib/colorscheme.json) for the `colorscheme` option
+- [templates/](../templates) for the `template` option
 
 
 Defaults

doc/service-tests.md

@@ -48,14 +48,15 @@ cache(function(data, match, sendBadge, request) {
     uri: 'https://api.travis-ci.org/' + userRepo + '.svg',
   };
   if (branch != null) {
-    options.uri += '?branch=' + branch;                         // (3)
+    options.uri += '?branch=' + branch;                         // 3
   }
   var badgeData = getBadgeData('build', data);
   request(options, function(err, res) {
     if (err != null) {
-      console.error('Travis error: ' + err.stack);              // 5
-      if (res) { console.error(''+res); }
-      badgeData.text[1] = 'inaccessible';
+      log.error('Travis error: ' + err.stack);
+      if (res) { log.error(''+res); }
+    }
+    if (checkErrorResponse(badgeData, err, res)) {              // 5
       sendBadge(format, badgeData);
       return;
     }
@@ -264,8 +265,8 @@ npm run coverage:report:open
 ```
 
 After searching `server.js` for the Travis code, we see that we've missed a
-big block: the error branch in the request callback. To test that, we simulate
-network connection errors on any unmocked requests.
+big block which is executed when `checkErrorResponse` returns `true`. To test
+that, we simulate network connection errors on any unmocked requests.
 
 ```js
 t.create('connection error')

frontend/components/dynamic-badge-maker.js

@@ -43,6 +43,7 @@ export default class DynamicBadgeMaker extends React.Component {
           <option value="" disabled>data type</option>
           <option value="json">json</option>
           <option value="xml">xml</option>
+          <option value="yaml">yaml</option>
         </select> {}
         <input
           className="short"

frontend/components/usage.js

@@ -126,6 +126,9 @@ export default class Usage extends React.PureComponent {
         <p>
           <code>/badge/dynamic/xml.svg?url=&lt;URL&gt;&amp;label=&lt;LABEL&gt;&amp;query=&lt;<a href="https://www.npmjs.com/package/xpath" target="_BLANK" title="XPath syntax">//data/subdata</a>&gt;&amp;colorB=&lt;COLOR&gt;&amp;prefix=&lt;PREFIX&gt;&amp;suffix=&lt;SUFFIX&gt;</code>
         </p>
+        <p>
+          <code>/badge/dynamic/yaml.svg?url=&lt;URL&gt;&amp;label=&lt;LABEL&gt;&amp;query=&lt;<a href="https://www.npmjs.com/package/jsonpath" target="_BLANK" title="JSONdata syntax">$.DATA.SUBDATA</a>&gt;&amp;colorB=&lt;COLOR&gt;&amp;prefix=&lt;PREFIX&gt;&amp;suffix=&lt;SUFFIX&gt;</code>
+        </p>
 
         <hr className="spacing" />
 

frontend/lib/badge-url.spec.js

@@ -38,43 +38,21 @@ describe('Badge URL functions', function() {
   });
 
   test(dynamicBadgeUrl, () => {
-    const jsonUrl = 'http://example.com/foo.json';
+    const dataUrl = 'http://example.com/foo.json';
     const query = '$.bar';
     const prefix = 'value: ';
 
     given(
       'http://img.example.com',
       'json',
       'foo',
-      jsonUrl,
+      dataUrl,
       query,
       { prefix, style: 'plastic' }
     ).expect([
       'http://img.example.com/badge/dynamic/json.svg',
       '?label=foo',
-      `&url=${encodeURIComponent(jsonUrl)}`,
-      `&query=${encodeURIComponent(query)}`,
-      `&prefix=${encodeURIComponent(prefix)}`,
-      '&style=plastic',
-    ].join(''))
-  });
-
-  test(dynamicBadgeUrl, () => {
-    const xmlUrl = 'http://example.com/foo.xml';
-    const query = '//bar';
-    const prefix = 'value: ';
-
-    given(
-      'http://img.example.com',
-      'xml',
-      'foo',
-      xmlUrl,
-      query,
-      { prefix, style: 'plastic' }
-    ).expect([
-      'http://img.example.com/badge/dynamic/xml.svg',
-      '?label=foo',
-      `&url=${encodeURIComponent(xmlUrl)}`,
+      `&url=${encodeURIComponent(dataUrl)}`,
       `&query=${encodeURIComponent(query)}`,
       `&prefix=${encodeURIComponent(prefix)}`,
       '&style=plastic',