Создавайте JavaDoc на GitLab при каждом нажатии - PullRequest
2 голосов
/ 10 июля 2019

Я работаю над проектом Java, который работает на GitLab.Я пытаюсь найти способ, с помощью которого GitLab автоматически генерирует документацию по Java при каждом нажатии.

Я пытался использовать плагин JavaDoc для Maven и вызывать его с конвейером.Но для плагина нужен файл javadoc.exe , который является локальным на моем компьютере, а не на GitLab.

Есть ли возможность запустить плагин без этого файла.Или может быть другой вариант, чтобы решить эту проблему?

Спасибо!

1 Ответ

1 голос
/ 10 июля 2019

Опция 1. Используйте образ JDK, который содержит javadoc

Proof:

$ docker run -it --rm openjdk javadoc --version
javadoc 12.0.1

Пример задания CI GitLab:

generate-doc:
  image: openjdk
  script:
    - javadoc ...

Опция 2. Установите javadoc черезnpm

См. документ: https://www.npmjs.com/package/javadoc

Подтверждение:

$ npm install -s javadoc
+ javadoc@1.0.6
added 235 packages from 100 contributors and audited 81 packages in 8.795s
found 0 vulnerabilities

$ javadoc --version
javadoc 12.0.1

Пример задания CI GitLab:

generate-doc:
  image: node
  script:
    - npm install -s javadoc
    - javadoc ...
...