Merge lp:~jelmer/brz/suggest-commit-message into lp:brz

[Jelmer Vernooij]

Add commit-message option to 'brz propose'.h

Add commit-message option to 'brz propose'.

[Jelmer Vernooij (jelmer)]

review: Approve

=== modified file 'breezy/plugins/propose/cmds.py'
--- breezy/plugins/propose/cmds.py	2019-01-24 00:56:15 +0000
+++ breezy/plugins/propose/cmds.py	2019-04-27 16:04:53 +0000
@@ -143,6 +143,9 @@
         Option('name', help='Name of the new remote branch.', type=str),
         Option('description', help='Description of the change.', type=str),
         Option('prerequisite', help='Prerequisite branch.', type=str),
+        Option(
+            'commit-message',
+            help='Set commit message for merge, if supported', type=str),
         ListOption('labels', short_name='l', type=text_type,
                    help='Labels to apply.'),
         Option('no-allow-lossy',
@@ -154,7 +157,7 @@
 
     def run(self, submit_branch=None, directory='.', hoster=None,
             reviewers=None, name=None, no_allow_lossy=False, description=None,
-            labels=None, prerequisite=None):
+            labels=None, prerequisite=None, commit_message=None):
         tree, branch, relpath = (
             controldir.ControlDir.open_containing_tree_or_branch(directory))
         if submit_branch is None:
@@ -191,7 +194,8 @@
         try:
             proposal = proposal_builder.create_proposal(
                 description=description, reviewers=reviewers,
-                prerequisite_branch=prerequisite_branch, labels=labels)
+                prerequisite_branch=prerequisite_branch, labels=labels,
+                commit_message=commit_message)
         except _mod_propose.MergeProposalExists as e:
             raise errors.BzrCommandError(gettext(
                 'There is already a branch merge proposal: %s') % e.url)
 
=== modified file 'breezy/plugins/propose/github.py'
--- breezy/plugins/propose/github.py	2019-02-14 19:33:19 +0000
+++ breezy/plugins/propose/github.py	2019-04-27 16:04:53 +0000
@@ -27,6 +27,7 @@
     MergeProposalBuilder,
     MergeProposalExists,
     PrerequisiteBranchUnsupported,
+    CommitMessageUnsupported,
     UnsupportedHoster,
     )
 
@@ -122,6 +123,9 @@
     def get_description(self):
         return self._pr.body
 
+    def get_commit_message(self):
+        return None
+
     def set_description(self, description):
         self._pr.edit(body=description, title=determine_title(description))
 
@@ -173,6 +177,7 @@
     name = 'github'
 
     supports_merge_proposal_labels = True
+    supports_merge_proposal_commit_message = False
 
     def __repr__(self):
         return "GitHub()"
@@ -346,10 +351,11 @@
         return None
 
     def create_proposal(self, description, reviewers=None, labels=None,
-                        prerequisite_branch=None):
+                        prerequisite_branch=None, commit_message=None):
         """Perform the submission."""
         if prerequisite_branch is not None:
             raise PrerequisiteBranchUnsupported(self)
+        # Note that commit_message is ignored, since github doesn't support it.
         import github
         # TODO(jelmer): Probe for right repo name
         if self.target_repo_name.endswith('.git'):
 
=== modified file 'breezy/plugins/propose/gitlabs.py'
--- breezy/plugins/propose/gitlabs.py	2019-02-14 19:33:19 +0000
+++ breezy/plugins/propose/gitlabs.py	2019-04-27 16:04:53 +0000
@@ -145,6 +145,9 @@
         self._mr.description = description
         self._mr.save()
 
+    def get_commit_message(self):
+        return None
+
     def _branch_url_from_project(self, project_id, branch_name):
         project = self._mr.manager.gitlab.projects.get(project_id)
         return gitlab_url_to_bzr_url(project.http_url_to_repo, branch_name)
@@ -176,6 +179,7 @@
     """GitLab hoster implementation."""
 
     supports_merge_proposal_labels = True
+    supports_merge_proposal_commit_message = False
 
     def __repr__(self):
         return "<GitLab(%r)>" % self.gl.url
@@ -360,11 +364,13 @@
         return None
 
     def create_proposal(self, description, reviewers=None, labels=None,
-                        prerequisite_branch=None):
+                        prerequisite_branch=None, commit_message=None):
         """Perform the submission."""
+        # https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
         if prerequisite_branch is not None:
             raise PrerequisiteBranchUnsupported(self)
         import gitlab
+        # Note that commit_message is ignored, since Gitlab doesn't support it.
         # TODO(jelmer): Support reviewers
         self.gl.auth()
         source_project = self.gl.projects.get(self.source_project_name)
 
=== modified file 'breezy/plugins/propose/launchpad.py'
--- breezy/plugins/propose/launchpad.py	2019-03-06 14:03:19 +0000
+++ breezy/plugins/propose/launchpad.py	2019-04-27 16:04:53 +0000
@@ -142,6 +142,13 @@
         self._mp.description = description
         self._mp.lp_save()
 
+    def get_commit_message(self):
+        return self._mp.commit_message
+
+    def set_commit_message(self, commit_message):
+        self._mp.commit_message = commit_message
+        self._mp.lp_save()
+
     def close(self):
         self._mp.setStatus(status='Rejected')
 
@@ -154,6 +161,8 @@
     # https://bugs.launchpad.net/launchpad/+bug/397676
     supports_merge_proposal_labels = False
 
+    supports_merge_proposal_commit_message = True
+
     def __init__(self, staging=False):
         self._staging = staging
         if staging:
@@ -394,13 +403,12 @@
 
 class LaunchpadBazaarMergeProposalBuilder(MergeProposalBuilder):
 
-    def __init__(self, lp_host, source_branch, target_branch, message=None,
+    def __init__(self, lp_host, source_branch, target_branch,
                  staging=None, approve=None, fixes=None):
         """Constructor.
 
         :param source_branch: The branch to propose for merging.
         :param target_branch: The branch to merge into.
-        :param message: The commit message to use.  (May be None.)
         :param staging: If True, propose the merge against staging instead of
             production.
         :param approve: If True, mark the new proposal as approved immediately.
@@ -421,14 +429,11 @@
             self.target_branch = target_branch
             self.target_branch_lp = self.launchpad.branches.getByUrl(
                 url=target_branch.user_url)
-        self.commit_message = message
         self.approve = approve
         self.fixes = fixes
 
     def get_infotext(self):
         """Determine the initial comment for the merge proposal."""
-        if self.commit_message is not None:
-            return self.commit_message.strip().encode('utf-8')
         info = ["Source: %s\n" % self.source_branch_lp.bzr_identity]
         info.append("Target: %s\n" % self.target_branch_lp.bzr_identity)
         return ''.join(info)
@@ -480,7 +485,7 @@
                              revid=self.source_branch.last_revision())
 
     def create_proposal(self, description, reviewers=None, labels=None,
-                        prerequisite_branch=None):
+                        prerequisite_branch=None, commit_message=None):
         """Perform the submission."""
         if labels:
             raise LabelsUnsupported()
@@ -497,7 +502,7 @@
                 target_branch=self.target_branch_lp,
                 prerequisite_branch=prereq,
                 initial_comment=description.strip(),
-                commit_message=self.commit_message,
+                commit_message=commit_message,
                 reviewers=[self.launchpad.people[reviewer].self_link
                            for reviewer in reviewers],
                 review_types=[None for reviewer in reviewers])
@@ -521,13 +526,12 @@
 
 class LaunchpadGitMergeProposalBuilder(MergeProposalBuilder):
 
-    def __init__(self, lp_host, source_branch, target_branch, message=None,
+    def __init__(self, lp_host, source_branch, target_branch,
                  staging=None, approve=None, fixes=None):
         """Constructor.
 
         :param source_branch: The branch to propose for merging.
         :param target_branch: The branch to merge into.
-        :param message: The commit message to use.  (May be None.)
         :param staging: If True, propose the merge against staging instead of
             production.
         :param approve: If True, mark the new proposal as approved immediately.
@@ -549,14 +553,11 @@
             self.target_branch = target_branch
             (self.target_repo_lp, self.target_branch_lp) = (
                 self.lp_host._get_lp_git_ref_from_branch(target_branch))
-        self.commit_message = message
         self.approve = approve
         self.fixes = fixes
 
     def get_infotext(self):
         """Determine the initial comment for the merge proposal."""
-        if self.commit_message is not None:
-            return self.commit_message.strip().encode('utf-8')
         info = ["Source: %s\n" % self.source_branch.user_url]
         info.append("Target: %s\n" % self.target_branch.user_url)
         return ''.join(info)
@@ -609,7 +610,7 @@
                 revid=self.source_branch.last_revision())
 
     def create_proposal(self, description, reviewers=None, labels=None,
-                        prerequisite_branch=None):
+                        prerequisite_branch=None, commit_message=None):
         """Perform the submission."""
         if labels:
             raise LabelsUnsupported()
@@ -626,7 +627,7 @@
                 merge_target=self.target_branch_lp,
                 merge_prerequisite=prereq_branch_lp,
                 initial_comment=description.strip(),
-                commit_message=self.commit_message,
+                commit_message=commit_message,
                 needs_review=True,
                 reviewers=[self.launchpad.people[reviewer].self_link
                            for reviewer in reviewers],
 
=== modified file 'breezy/plugins/propose/propose.py'
--- breezy/plugins/propose/propose.py	2019-02-15 02:29:10 +0000
+++ breezy/plugins/propose/propose.py	2019-04-27 16:04:53 +0000
@@ -111,6 +111,14 @@
         """Set the description of the merge proposal."""
         raise NotImplementedError(self.set_description)
 
+    def get_commit_message(self):
+        """Get the proposed commit message."""
+        raise NotImplementedError(self.get_commit_message)
+
+    def set_commit_message(self, commit_message):
+        """Set the propose commit message."""
+        raise NotImplementedError(self.set_commit_message)
+
     def get_source_branch_url(self):
         """Return the source branch."""
         raise NotImplementedError(self.get_source_branch_url)
@@ -154,13 +162,14 @@
         raise NotImplementedError(self.get_infotext)
 
     def create_proposal(self, description, reviewers=None, labels=None,
-                        prerequisite_branch=None):
+                        prerequisite_branch=None, commit_message=None):
         """Create a proposal to merge a branch for merging.
 
         :param description: Description for the merge proposal
         :param reviewers: Optional list of people to ask reviews from
         :param labels: Labels to attach to the proposal
         :param prerequisite_branch: Optional prerequisite branch
+        :param commit_message: Optional commit message
         :return: A `MergeProposal` object
         """
         raise NotImplementedError(self.create_proposal)
@@ -174,6 +183,10 @@
     # proposals?
     supports_merge_proposal_labels = None
 
+    # Does this hoster support suggesting a commit message in the
+    # merge proposal?
+    supports_merge_proposal_commit_message = None
+
     # The base_url that would be visible to users. I.e. https://github.com/
     # rather than https://api.github.com/
     base_url = None
 
=== modified file 'doc/en/release-notes/brz-3.1.txt'
--- doc/en/release-notes/brz-3.1.txt	2019-03-06 14:23:50 +0000
+++ doc/en/release-notes/brz-3.1.txt	2019-04-27 16:04:53 +0000
@@ -27,6 +27,10 @@
 .. Improvements to existing commands, especially improved performance 
    or memory usage, or better results.
 
+* A new ``--commit-message`` option has been added to
+  ``brz propose``, for hosting sites that support it.
+  (Jelmer Vernooij)
+
 Bug Fixes
 *********