Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Delta Between Two Patch Sets: sitescripts/hg/README.md

Issue 29339623: Issue 3681 - Add suport for "Fixes XXXX - ..." commit messages (Closed)
Left Patch Set: Fix the warnings flagged by flake8-abp and the capitalisation of Platform in the config example Created May 17, 2016, 10:20 a.m.
Right Patch Set: Fix Strunk+White violations Created May 18, 2016, 8:29 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « .sitescripts.example ('k') | sitescripts/hg/bin/update_issues.py » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
1 # Mercurial hooks 1 # Mercurial hooks
2 2
3 `sitescripts/hg` contains Mercurial hooks for integration with other components 3 `sitescripts/hg` contains Mercurial hooks for integration with other components
4 of our infrastructure. 4 of our infrastructure.
5 5
6 ## IRC integration 6 ## IRC integration
7 7
8 `irchook.py` contains a commit hook that posts the information about new pushed 8 `irchook.py` contains a commit hook that posts the information about new pushed
9 commits to an IRC channel. 9 commits to an IRC channel.
10 10
11 ## Trac integration 11 ## Trac integration
12 12
13 `update_issues.py` contains two hooks: `changegroup_hook` and `pushkey_hook`. 13 `update_issues.py` contains two hooks: `changegroup_hook` and `pushkey_hook`.
14 They will recognise issue references in commit messages and update referenced 14 They will recognise issue references in commit messages and update referenced
15 issues in Adblock Plus issue tracker. 15 issues in the Adblock Plus issue tracker.
Felix Dahlke 2016/05/17 20:12:05 Nit: "in the" maybe?
Vasily Kuznetsov 2016/05/18 08:30:44 Done.
16 16
17 The format of the commit messages is "ISSUE-REFERENCE - MESSAGE" 17 The format of the commit messages is "ISSUE-REFERENCE - MESSAGE"
18 where ISSUE-REFERENCE is one of "Noissue", "Issue NUMBER" or "Fixes NUMBER". 18 where ISSUE-REFERENCE is one of "Noissue", "Issue NUMBER" or "Fixes NUMBER".
19 Several "Issue" and "Fixes" references separated by commas can be present 19 Several "Issue" and "Fixes" references separated by commas can be present
20 in the same commit message (for example: "Issue 1, Fixes 2 - Two issues"). 20 in the same commit message (for example: "Issue 1, Fixes 2 - Two issues").
21 Such commit will affect all the referenced issues. 21 Such commit will affect all the referenced issues.
22 22
23 * `changegroup_hook` will post a comment with the link to the commit into the 23 * `changegroup_hook` will post a comment with the link to the commit into the
24 issue if the issue is referenced from the commit message. 24 issue if the issue is referenced from the commit message.
25 * `pushkey_hook` will close the issues and assign milestones to them (based 25 * `pushkey_hook` will close the issues and assign milestones to them (based
26 on their module) when `master` bookmark passes over the commits that fix 26 on their module) when the `master` bookmark passes over the commits that fix
Felix Dahlke 2016/05/17 20:12:06 Nit: "when the"?
Vasily Kuznetsov 2016/05/18 08:30:44 Done.
27 them. It will not assign a milestone if the issue already has one. 27 them. It will not assign a milestone if the issue already has one.
28 28
29 ### Configuring the repository 29 ### Configuring the repository
30 30
31 `changegroup_hook` should be installed as `changegroup` or 31 `changegroup_hook` should be installed as `changegroup` or
32 `pretxnchangegroup` hook. `pushkey_hook` should be installed as 32 `pretxnchangegroup` hook. `pushkey_hook` should be installed as
33 `pushkey` or `prepushkey` hook. For example (in `.hg/hgrc`): 33 `pushkey` or `prepushkey` hook. For example (in `.hg/hgrc`):
34 34
35 [hooks] 35 [hooks]
36 pretxnchangegroup = python:.../update_issues.py:changegroup_hook 36 pretxnchangegroup = python:.../update_issues.py:changegroup_hook
(...skipping 12 matching lines...) Expand all
49 platform=adblock-plus(-[\d\.]+)?-for-chrome-opera-safari(-next)? 49 platform=adblock-plus(-[\d\.]+)?-for-chrome-opera-safari(-next)?
50 Adblock-Plus-for-Firefox=adblock-plus(-[\d\.]+)?-for-firefox(-next)? 50 Adblock-Plus-for-Firefox=adblock-plus(-[\d\.]+)?-for-firefox(-next)?
51 51
52 `hg.track_xmlrpc_url` key from is used to determine the address of XMLRPC 52 `hg.track_xmlrpc_url` key from is used to determine the address of XMLRPC
53 interface of Trac and `hg.issue_url_template` as a template for producing links 53 interface of Trac and `hg.issue_url_template` as a template for producing links
54 to the referenced issues that are displayed in the log. 54 to the referenced issues that are displayed in the log.
55 55
56 The keys of the `hg_module_milestones` section are module names and the values 56 The keys of the `hg_module_milestones` section are module names and the values
57 are corresponding milestone regular expressions (they are matched 57 are corresponding milestone regular expressions (they are matched
58 case-insensitively). The first open milestone that matches the regular 58 case-insensitively). The first open milestone that matches the regular
59 expression of issue's module will be assigned to the issue when the `master` 59 expression of the issue's module will be assigned to the issue when the
Felix Dahlke 2016/05/17 20:12:06 Nit: "of an"?
Vasily Kuznetsov 2016/05/18 08:30:44 Should not it be "of the issue's module"? We're ta
Felix Dahlke 2016/05/18 08:37:22 Acknowledged.
60 bookmark passes a commit that fixes it. 60 `master` bookmark passes a commit that fixes it.
61 61
62 ### Master bookmark 62 ### Master bookmark
63 63
64 What exactly does it mean when we say _`master` bookmark is passing a commit_? 64 What exactly does it mean when we say _`master` bookmark is passing a commit_?
65 The idea is that if the `master` bookmark _passed_ a commit we will have 65 The idea is that if the `master` bookmark _passed_ a commit we will have
66 those changes in our working copy when we do `hg checkout master`. 66 those changes in our working copy when we do `hg checkout master`.
Felix Dahlke 2016/05/17 20:12:05 Nit: `checkout` is just an alias for `update`, whi
Vasily Kuznetsov 2016/05/18 08:30:44 I think I wrote it this way thinking about a unive
Felix Dahlke 2016/05/18 08:37:22 Acknowledged.
67 67
68 Let's first look at a simple case, linear commit history like this: 68 Let's first look at a simple case, linear commit history like this:
69 69
70 one <- two <- three 70 one <- two <- three
71 71
72 Here `one` is a parent commit of `two` and `two` is a parent of `three`. If 72 Here `one` is a parent commit of `two` and `two` is a parent of `three`. If
73 the `master` bookmark was on `one` and then moved to `three`, we say that it 73 the `master` bookmark was on `one` and then moved to `three`, we say that it
74 passed `two` and `three`. This would happen naturally if we clone the 74 passed `two` and `three`. This would happen naturally if we clone the
75 repository that contains `one` with the `master` bookmark pointing to it, 75 repository that contains `one` with the `master` bookmark pointing to it,
76 check out `master`, author two commits and then push them. 76 check out `master`, author two commits and then push them.
77 77
78 A somewhat similar thing happens when we have branches: 78 A somewhat similar thing happens when we have branches:
79 79
80 one <---- two <---- three 80 one <---- two <---- three
81 \ / 81 \ /
82 \-- dos <--/ 82 \-- dos <--/
83 83
84 Here `one` is a parent commit of `two` and `dos` and they are both parents 84 Here `one` is a parent commit of `two` and `dos` and they are both parents
85 of `three`. If the `master` bookmark was on `two` and now is on `three`, 85 of `three`. If the `master` bookmark was on `two` and now is on `three`,
86 we say that it passed `three` and `dos`. What happened here is that by `three` 86 we say that it passed `three` and `dos`. What happened here is that by `three`
87 we've merged a branch containing `dos` into the master branch that was going 87 we've merged a branch containing `dos` into the master branch that was going
88 through `one` and `two`. 88 through `one` and `two`.
LEFTRIGHT

Powered by Google App Engine
This is Rietveld