Как включить git changelog в электронные письма Дженкинса?

есть ли способ импортировать журнал изменений, который генерируется Дженкинсом, в тему письма (либо по умолчанию, либо email-ext плагин)?

Я новичок в конфигурации Дженкинса, поэтому прошу прощения, если это простая проблема, но я не смог найти ничего в документации по электронной почте-ext.

4 ответов


Я настроил плагин Email-ext для использования токена изменений (официальная документация здесь):

Changes:
${CHANGES, showPaths=true, format="%a: %r %p \n--\"%m\"", pathFormat="\n\t- %p"}

это печатает следующее в моих уведомлениях о сборке:

Changes:
Username: 123
    - Project/Filename1.m
    - Project/Filename2.m
    -- "My log message"

для HTML-сообщений я поместил тот же код в div и добавил форматирование:

<div style="padding-left: 30px; padding-bottom: 15px;">
${CHANGES, showPaths=true, format="<div><b>%a</b>: %r %p </div><div style=\"padding-left:30px;\"> &#8212; &#8220;<em>%m</em>&#8221;</div>", pathFormat="</div><div style=\"padding-left:30px;\">%p"}
</div>

вот пример скриншота того, как он выглядит в электронных письмах, отправленных Дженкинсом сейчас (этот конкретный коммит пришел из Subversion, но он работает точно так же для Git и другие системы управления версиями):

Change list for Jenkins


из оригинальной документации: чтобы увидеть список всех доступных токенов электронной почты и то, что они отображают, вы можете нажать "?"(вопросительный знак), связанный со ссылкой на маркер содержимого в нижней части раздела email-ext на экране конфигурации проекта.

вот результаты:

${CHANGES}
Displays the changes since the last build.

showDependencies
    If true, changes to projects this build depends on are shown. Defaults to false
showPaths
    If true, the paths, modifued by a commit are shown. Defaults to false
format
    For each commit listed, a string containing %X, where %x is one of:

    %a
        author
    %d
        date
    %m
        message
    %p
        path
    %r
        revision

    Not all revision systems support %d and %r. If specified showPaths argument is ignored. Defaults to "[%a] %m\n"
pathFormat
    A string containing %p to indicate how to print paths. Defaults to "\t%p\n"

не в теме письма, хотя вы можете отправить журнал изменений получателю в виде вложения в Почте с помощью Git Changelog Плагин как действие сборки post в Jenkins работа. Выберите Create a file установите флажок, Укажите имя файла (CHANGELOG.md для меня), как на рисунке ниже:

enter image description here

убедитесь, что вы настроили Управление Исходным Кодом as GIT в работе Дженкинса.

затем create Редактировать Уведомления По Электронной Почте действие post build и скопируйте имя файла журнала изменений git как значение Attachments, как на рисунке ниже:

enter image description here


из версии 2.0 и более поздних версий Плагин Git Changelog, вы можете получить журнал изменений в виде строки в конвейере. А потом просто используй эту переменную в Почте.

node {
 deleteDir()
 sh """
 git clone git@github.com:jenkinsci/git-changelog-plugin.git .
 """

 def changelogString = gitChangelog returnType: 'STRING',
  from: [type: 'REF', value: 'git-changelog-1.50'],
  to: [type: 'REF', value: 'master'],
  template: """
  <h1> Git Changelog changelog </h1>

<p>
Changelog of Git Changelog.
</p>

{{#tags}}
<h2> {{name}} </h2>
 {{#issues}}
  {{#hasIssue}}
   {{#hasLink}}
<h2> {{name}} <a href="{{link}}">{{issue}}</a> {{title}} </h2>
   {{/hasLink}}
   {{^hasLink}}
<h2> {{name}} {{issue}} {{title}} </h2>
   {{/hasLink}}
  {{/hasIssue}}
  {{^hasIssue}}
<h2> {{name}} </h2>
  {{/hasIssue}}


   {{#commits}}
<a href="https://github.com/tomasbjerre/git-changelog-lib/commit/{{hash}}">{{hash}}</a> {{authorName}} <i>{{commitTime}}</i>
<p>
<h3>{{{messageTitle}}}</h3>

{{#messageBodyItems}}
 <li> {{.}}</li> 
{{/messageBodyItems}}
</p>


  {{/commits}}

 {{/issues}}
{{/tags}}
  """

mail bcc: '', body: """Here is the changelog:

${changelogString}
""", cc: '', from: '', replyTo: '', subject: 'The Changelog', to: 'the@email'
}