u/pc/rhodecode-enterprise-ce-fork-pc Commit - r3414:60337891

rcextensions: updated example and template override with more docs.

marcink -

r3414:60337891 stable

parent child

rhodecode/config/rcextensions/examples/custom_integration_templates.py ~~rhodecode/config/rcextensions/examples/custom_email_integration_template.py~~

0 renamed +23 -11

-            # This code allows override the integrations templates. Put this into the __init__.py
+            # This code allows override the integrations templates.
-            # file of rcextensions
+            # Put this into the __init__.py file of rcextensions to override the templates
-            # EMAIL
+            # EMAIL Integration
             from rhodecode.integrations import email
             email.REPO_PUSH_TEMPLATE_HTML = email.Template('''
             <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
             <html xmlns="http://www.w3.org/1999/xhtml">
             <head>
                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
                 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
                 <title>${subject}</title>
                 <style type="text/css">
                     /* Based on The MailChimp Reset INLINE: Yes. */
                     #outlook a {padding:0;} /* Force Outlook to provide a "view in browser" menu link. */
                     body{width:100% !important; -webkit-text-size-adjust:100%; -ms-text-size-adjust:100%; margin:0; padding:0;}
                     /* Prevent Webkit and Windows Mobile platforms from changing default font sizes.*/
                     .ExternalClass {width:100%;} /* Force Hotmail to display emails at full width */
                     .ExternalClass, .ExternalClass p, .ExternalClass span, .ExternalClass font, .ExternalClass td, .ExternalClass div {line-height: 100%;}
                     /* Forces Hotmail to display normal line spacing.  More on that: http://www.emailonacid.com/forum/viewthread/43/ */
                     #backgroundTable {margin:0; padding:0; line-height: 100% !important;}
                     /* End reset */
                     /* defaults for images*/
                     img {outline:none; text-decoration:none; -ms-interpolation-mode: bicubic;}
                     a img {border:none;}
                     .image_fix {display:block;}
                     body {line-height:1.2em;}
                     p {margin: 0 0 20px;}
                     h1, h2, h3, h4, h5, h6 {color:#323232!important;}
                     a {color:#427cc9;text-decoration:none;outline:none;cursor:pointer;}
                     a:focus {outline:none;}
                     a:hover {color: #305b91;}
                     h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {color:#427cc9!important;text-decoration:none!important;}
                     h1 a:active, h2 a:active,  h3 a:active, h4 a:active, h5 a:active, h6 a:active {color: #305b91!important;}
                     h1 a:visited, h2 a:visited,  h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited {color: #305b91!important;}
                     table {font-size:13px;border-collapse:collapse;mso-table-lspace:0pt;mso-table-rspace:0pt;}
                     table td {padding:.65em 1em .65em 0;border-collapse:collapse;vertical-align:top;text-align:left;}
                     input {display:inline;border-radius:2px;border-style:solid;border: 1px solid #dbd9da;padding:.5em;}
                     input:focus {outline: 1px solid #979797}
                     @media only screen and (-webkit-min-device-pixel-ratio: 2) {
                     /* Put your iPhone 4g styles in here */
                     }
                     /* Android targeting */
                     @media only screen and (-webkit-device-pixel-ratio:.75){
                     /* Put CSS for low density (ldpi) Android layouts in here */
                     }
                     @media only screen and (-webkit-device-pixel-ratio:1){
                     /* Put CSS for medium density (mdpi) Android layouts in here */
                     }
                     @media only screen and (-webkit-device-pixel-ratio:1.5){
                     /* Put CSS for high density (hdpi) Android layouts in here */
                     }
                     /* end Android targeting */
                 </style>
                 <!-- Targeting Windows Mobile -->
                 <!--[if IEMobile 7]>
                 <style type="text/css">
                 </style>
                 <![endif]-->
                 <!--[if gte mso 9]>
                     <style>
                     /* Target Outlook 2007 and 2010 */
                     </style>
                 <![endif]-->
             </head>
             <body>
             <!-- Wrapper/Container Table: Use a wrapper table to control the width and the background color consistently of your email. Use this approach instead of setting attributes on the body tag. -->
             <table cellpadding="0" cellspacing="0" border="0" id="backgroundTable" align="left" style="margin:1%;width:97%;padding:0;font-family:sans-serif;font-weight:100;border:1px solid #dbd9da">
                 <tr>
                     <td valign="top" style="padding:0;">
                         <table cellpadding="0" cellspacing="0" border="0" align="left" width="100%">
                             <tr><td style="width:100%;padding:7px;background-color:#202020" valign="top">
                                 <a style="color:#eeeeee;text-decoration:none;" href="${instance_url}">
                                     ${'RhodeCode'}
                                 </a>
                             </td></tr>
                             <tr>
                                 <td style="padding:15px;" valign="top">
                                     % if data['push']['commits']:
                                         % for commit in data['push']['commits']:
                                         <a href="${commit['url']}">${commit['short_id']}</a> by ${commit['author']} at ${commit['date']} <br/>
                                         ${commit['message_html']} <br/>
                                         <br/>
                                         % endfor
                                     % else:
                                         No commit data
                                     % endif
                                 </td>
                             </tr>
                         </table>
                     </td>
                 </tr>
             </table>
             <!-- End of wrapper table -->
             <p><a style="margin-top:15px;margin-left:1%;font-family:sans-serif;font-weight:100;font-size:11px;color:#666666;text-decoration:none;" href="${instance_url}">
                 ${'This is a notification from RhodeCode. %(instance_url)s' % {'instance_url': instance_url}}
             </a></p>
             </body>
             </html>
             ''')
-            # JIRA (EE ONLY)
+            # JIRA Integration (EE ONLY)
+            # available variables:
+            # url, short_id ,author
+            # branch, commit_message
+            # commit (dict data for commit)
             from rc_integrations import jira_tracker
-            jira_tracker.COMMENT_TEMPLATE_PULL_REQUEST = jira_tracker.Template('''
+            # used for references issues without transition, e.g `This ticket references PROJ-123`
-            ${action} by ${author} (status: ${status}). \n
-            pull-request: ${url}
-            ''')
             jira_tracker.COMMENT_TEMPLATE_COMMIT = jira_tracker.Template('''
             Commit `${short_id}` by ${author} on `${branch}` branch references this issue. \n
             ${url}\n
             ## MODIFICATION add custom COMMIT message to the comment
             ${commit['message']}
             ''')
+            # used when there's a transition, e.g referenced issues status goes from
+            # open to resolved this is used in correlation with something like `closes PROJ-123`
             jira_tracker.COMMENT_TEMPLATE_COMMIT_WITH_STATUS = jira_tracker.Template('''
             Commit `${short_id}` by ${author} on `${branch}` branch changed this issue. \n
             '{url}\n
             ## MODIFICATION add custom COMMIT message to the comment
             ${commit['message']}
             ''')
+            jira_tracker.COMMENT_TEMPLATE_PULL_REQUEST = jira_tracker.Template('''
+            ${action} by ${author} (status: ${status}). \n
+            pull-request: ${url}
+            ''')
             # REDMINE (EE ONLY)
+            # available variables:
+            # url, short_id ,author
+            # branch, commit_message
+            # commit (dict data for commit)
             from rc_integrations import redmine_tracker
+            # used for references issues without transition, e.g `This ticket references #123`
             redmine_tracker.COMMENT_TEMPLATE_COMMIT = redmine_tracker.Template('''
             Commit `${short_id}` by ${author} on `${branch}` branch references this issue. \n
             commit: ${url}\n
             ## MODIFICATION add custom COMMIT message to the comment
             message:
             ```
             ${commit['message']}
             ```
             ''')
+            # used when there's a transition, e.g referenced issues status goes from
+            # open to resolved this is used in correlation with something like `closes #123`
             redmine_tracker.COMMENT_TEMPLATE_COMMIT_WITH_STATUS = redmine_tracker.Template('''
             Commit `${short_id}` by ${author} on `${branch}` branch changed this issue. \n
             commit: ${url}\n
             ## MODIFICATION add custom COMMIT message to the comment
             message:
             ```
             ${commit['message']}
             ```
             ''')
             redmine_tracker.COMMENT_TEMPLATE_PULL_REQUEST = redmine_tracker.Template('''
             ${action} by ${author} (status: ${status}). \n'
             ${url}\n
             ## MODIFICATION add custom COMMIT message to the comment
             message:
             ```
             ${commit['message']}
             ```
             ''')

rhodecode/config/rcextensions/helpers/extract_pre_commits.py

0 +2 -1

             # -*- coding: utf-8 -*-
             # Copyright (C) 2016-2018 RhodeCode GmbH
             #
             # This program is free software: you can redistribute it and/or modify
             # it under the terms of the GNU Affero General Public License, version 3
             # (only), as published by the Free Software Foundation.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU Affero General Public License
             # along with this program.  If not, see <http://www.gnu.org/licenses/>.
             #
             # This program is dual-licensed. If you wish to learn more about the
             # RhodeCode Enterprise Edition, including its added features, Support services,
             # and proprietary license terms, please see https://rhodecode.com/licenses/
             """
             us in hooks::
                 from .helpers import extract_pre_commits
                 # returns list of dicts with key-val fetched from extra fields
                 commit_list = extract_pre_commits.run(**kwargs)
             """
             import re
             import collections
             import json
             def get_hg_commits(repo, refs):
                 commits = []
                 return commits
             def get_git_commits(repo, refs):
                 commits = []
                 for data in refs:
                     # we should now extract commit data
                     old_rev = data['old_rev']
                     new_rev = data['new_rev']
                     if '00000000' in old_rev:
                         # new branch, we don't need to extract nothing
                         return commits
                     git_env = dict(data['git_env'])
+                    # https://github.com/git/git/blob/master/Documentation/pretty-formats.txt
                     cmd = [
                         'log',
-                        '--pretty=format:{"commit_id": "%H",  "author": "%aN <%aE>",  "date": "%ad",  "message": "%f"}',
+                        '--pretty=format:{"commit_id": "%H",  "author": "%aN <%aE>",  "date": "%ad",  "message": "%s"}',
                         '{}...{}'.format(old_rev, new_rev)
                     ]
                     stdout, stderr = repo.run_git_command(cmd, extra_env=git_env)
                     for line in stdout.splitlines():
                         try:
                             data = json.loads(line)
                             commits.append(data)
                         except Exception:
                             print('Failed to load data from GIT line')
                 return commits
             def run(*args, **kwargs):
                 from rhodecode.model.db import Repository
                 vcs_type = kwargs['scm']
                 # use temp name then the main one propagated
                 repo_name = kwargs.pop('REPOSITORY', None) or kwargs['repository']
                 repo = Repository.get_by_repo_name(repo_name)
                 vcs_repo = repo.scm_instance(cache=False)
                 commits = []
                 if vcs_type == 'git':
                     for rev_data in kwargs['commit_ids']:
                         new_environ = dict((k, v) for k, v in rev_data['git_env'])
                     commits = get_git_commits(vcs_repo, kwargs['commit_ids'])
                 if vcs_type == 'hg':
                     for rev_data in kwargs['commit_ids']:
                         new_environ = dict((k, v) for k, v in rev_data['hg_env'])
                     commits = get_hg_commits(vcs_repo, kwargs['commit_ids'])
                 return commits

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages