regression in version 4.0.0-beta.19 compared to version 4.0.0-beta.18 - the build --github option no longer does anything

[gkovacs]

I am using the command

./node_modules/documentation/bin/documentation.js build src_gen/libs_frontend/*.js src_gen/libs_backend/*.js --github -f html -o docs

Using the default theme. With version 4.0.0-beta.18 and previous versions (tested with every version from 4.0.0-beta.14 to 4.0.0-beta.18) the github links correctly appear. However, with 4.0.0-beta.19 the github links are no longer shown (even though I'm still using the same command). This happens with every repository I have tested with, but if you need a sample example see https://github.com/habitlab/habitlab

[gkovacs]

I've located the issue: it seems in module.exports for lib/github.js the format has changed, but the default template doesn't seem to have been updated accordingly. As reverting back to the version of lib/github.js in 4.0.0-beta.18 fixes this issue:

'use strict';
/* @flow */

var path = require('path');
var findGit = require('../lib/git/find_git');
var getGithubURLPrefix = require('../lib/git/url_prefix');

/**
 * Attempts to link code to its place on GitHub.
 *
 * @name linkGitHub
 * @param {Object} comment parsed comment
 * @return {Object} comment with github inferred
 */
module.exports = function(comment /*: Comment*/) {
  var repoPath = findGit(comment.context.file);
  var root = repoPath ? path.dirname(repoPath) : '.';
  var urlPrefix = getGithubURLPrefix(root);
  var fileRelativePath = comment.context.file
    .replace(root + path.sep, '')
    .split(path.sep)
    .join('/');

  if (urlPrefix) {
    comment.context.github = urlPrefix +
        fileRelativePath +
        '#L' +
        comment.context.loc.start.line +
        '-' +
        'L' +
        comment.context.loc.end.line
    comment.context.path = fileRelativePath
  }
  return comment;
};

[tmcw]

Thanks for the error report! I'll be able to get this fixed in the next release.