Как должен выглядеть комментарий, чтобы его можно было включить в документацию для hubot?

Насколько я понял, команда hubot help должна отображать все команды на основе комментария в начале каждого скрипта. По какой-то причине в нем нет справки для моего файла, может ли кто-нибудь заметить ошибку?

# Description:
#   Hubot interface to octopus deploy
#
# Commands:
#   hubot octo promote <project> from <env1> to <env2> - Hubot deploys the latest release of <project> on <env1> to <env2>
#   hubot octo deploy <project> version <version> to <env> - Hubot deploys the specified version of <project> to <env>
#   hubot octo status - Hubot prints a dashboard of environments and currently deployed versions.
#
# Author:
#   kneumei


_ = require('underscore')._
q = require('q')
util = require('util')
....

Полный скрипт находится здесь: https://github.com/mastoj/hubot-octopus/blob/master/src/octopus.coffee


hubot
person Tomas Jansson    schedule 07.09.2015    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Вы когда-нибудь заставляли это работать? Я борюсь с той же проблемой. После нажатия на heroku похоже, что модуль hubot-octopus собран просто отлично, и я включил его в external-scripts.json вместе с остальными модулями, но hubot не перечисляет команды octo в справке и делает не реагировать на окто-команды.

remote: -----> Build succeeded!
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]              <----
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        ├── [email protected]
remote:        └── [email protected]

ОБНОВЛЕНИЕ: оказалось, что моя проблема заключалась в том, что переменная среды для ключа API Octopus была неправильной. Когда это было неправильно установлено, он просто молча терпел неудачу. Я использовал OCTOPUS_API_KEY, как указано в документации, но фактическая реализация требует OCTOPUS_KEY. Добавлен запрос на включение в hubot-octopus для исправления документации.

person henningst    schedule 29.10.2015