Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 106862 - use task description as comments in CVS commit
Summary: use task description as comments in CVS commit
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: 0.3   Edit
Hardware: PC All
: P2 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Mik Kersten CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-08-12 11:37 EDT by Eugene Kuleshov CLA
Modified: 2005-11-29 05:59 EST (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Eugene Kuleshov CLA 2005-08-12 11:37:58 EDT
When starting new developement there is a good chance that there will be commit
to version control just before completion of the task. So, why not to use task
description as a commit description text (and probably also allow to optionally
close task from the commit dialog).
Comment 1 Mik Kersten CLA 2005-08-12 13:26:12 EDT
I think that this is a great idea because I'm always pasting the bug id and
description into my commit message.  How about we add a "Resolve and commit"
button to the Task List?  Then a dialog pops up with the ID for (or link to?)
the bug, the subject, and space for you to add additional comments.  E.g.

Resolved: Allow to use opened task descriptions as comments in CVS commit
https://bugs.eclipse.org/bugs/show_bug.cgi?id=106862
Last comment: bla bla bla



Comment 2 Eugene Kuleshov CLA 2005-08-12 16:37:13 EDT
That is interesting. Actually I was thinking about automatically adding an active
task name into comments text area in CVS commit dialog. 

But now that you've
mentioned it there are some interesting possibilities:

-- put an active task
name into the commit comment. E.g:

Task: 106862: Allow to use opened task
descriptions as comments in CVS commit

Note that there is no need to add
an url, because it suppose to be configured per project. See issue 58646 or
additional details. https://bugs.eclipse.org/bugs/show_bug.cgi?id=58646

--
as you've said use bug details to populate cvs commit comment

-- use commit
message to atomatically update attached bug report (e.g. post commit comment
and the list of affected classes). This is usually done by some hooks on cvs/svn
server, but IDE integration could be somehow interesting too.



Comment 3 Mik Kersten CLA 2005-08-17 13:57:03 EDT
Somme additional comments of Eugene's from bug#107085  that are relevant:

> But could you clarify what you mean about monitoring CVS activities?

Well, when you run syncronize and see bunch of incoming changes with comment
like "107085, 107086" you sort of curious what the hack these bugs was about.
Now I have to manually add them into the mylar task list in order to see
description. It would be faster to be able to just type issue id.

Another "fancy" way of doing this could be to drag resource (or folder/commit
set on "commit sets" mode) from Synchronize view into the Mylar task list view
and Mylar would try to find matching issues and add them as tasks. But I believe
it would require too much heuristic. 
Comment 4 Mik Kersten CLA 2005-08-29 12:57:14 EDT
This will be a nice feature to incorporate, but moving to next week.  We have 
to be careful to ensure that it doesn't couple mylar too closely to 
org.eclipse.team.ccvs to ensure that the interaction is as convenient when 
other repositories are used.
Comment 5 Eugene Kuleshov CLA 2005-08-29 13:30:15 EDT
Mik, shouldn't it be something like a "comment provider" extension point, so CVS
plugin could use it to fetch comments from a current task?
Comment 6 Mik Kersten CLA 2005-08-29 22:28:59 EDT
That could be a good way of doing it--that way additional repository providers
could create an optional dependancy to that Mylar extension point, and it would
be easier to move the extension point into the team plug-in eventually.  I'll
probably do it as API first, and then propose the extension point on this report
to get your feedback.
Comment 7 Eugene Kuleshov CLA 2005-08-29 22:34:57 EDT
(In reply to comment #6)
> That could be a good way of doing it--that way additional repository providers
> could create an optional dependancy to that Mylar extension point, and it would
> be easier to move the extension point into the team plug-in eventually.  I'll
> probably do it as API first, and then propose the extension point on this report
> to get your feedback.

It seems that team plugin should actually own such extension point, so other
sources could contribute data to be used as commit comments (e.g. refactoring
log or local history). 

We should invite Michael Valenta or somebody else from team component team to
commit on this because this extension point could be another candidate for high
level team integration API.
Comment 8 Erkki Lindpere CLA 2005-10-25 18:16:06 EDT
I just had almost the same idea for an enhancement request (although I've moved
to SVN for lack of skill of setting up CVS on linux).

It would be also interesting to be able to share task context in CVS, but the
file sizes are probably too big for that. But somehow the idea of sharing task
context between developers seems really cool to me -- maybe it could be done
with ECF (Eclipse Communication Framework)?
Comment 9 Eugene Kuleshov CLA 2005-10-26 06:07:54 EDT
(In reply to comment #8)
> It would be also interesting to be able to share task context in CVS, but the
> file sizes are probably too big for that. But somehow the idea of sharing task
> context between developers seems really cool to me -- maybe it could be done
> with ECF (Eclipse Communication Framework)?

I think somebody already working on the prototype for this. Mik and Brock should
be able to tell...
Comment 10 Mik Kersten CLA 2005-10-26 12:24:35 EDT
Erkki, we will make sure that the automatic generation of the comment will be
easy to have work for SVN as well.  As Eugene has pointed out this would benefit
from some common Team functionality in the Eclispe SDK, but for now the best we
can do is make a generic API and then suggest that Team integrate that at some
point.

Regarding your other suggestion: I couldn't agree more and support for
automatically attaching contexts to bug reports will get done within a week or
two (bug 113848).  The contexts themselves are smaller than screen captures so
size isn't much of an issue.  On the Mylar project I'm considering requesting
that all resolved issues get an attached context.  That makes it way easier to
review what was done when a patch gets submitted, etc.  In case any design
issues come up, could you add yourself as a CC to that report?
Comment 11 Mik Kersten CLA 2005-11-09 15:44:08 EST
Done: there is now a new context menu called Commit Resources in Context... that will
commit everything in the task context and fill the description of the task into the comment
area.  Details will be in the New & Noteworthy.

Note: this is an Eclipse SDK-specific
(i.e. CVS) feature.  However, I used the ChangeSet mechanism, so any other plug-in (e.g.
Subclipse) should be able to use this functionality.  What such a plug-ins commit wizard
would need to do is the same as org.eclipse.team.cvs.ui's CommitWizardCommitPage.getProposedComment(..)
does and get all the active ChangeSets, and see if one of them (i.e. the MylarDynamicChangeSet)
has a proposed comment for the resources that are to be committed.

Comment 12 Eugene Kuleshov CLA 2005-11-09 17:04:58 EST
Cool stuff! I coudn't wait and tried this feature using code from CVS.

I think that it would be more intuitive to the user to have commit action on the
Mylar's dynamic change set node in Synchronize view.

Also, to keep you busy there are issues 115705, 115707 and 115709  :)

Also note that Subclipse plugin have no support for change sets and it is
unclear if/when it will be added there.
Comment 13 Brock Janiczak CLA 2005-11-10 04:20:49 EST
No, Subclipse does not yet support change sets yet.  There are no technical
reasons why it couldn't be added though.  In Subversion each revision is in
effect a changeset.

The biggest problem is that the ChangeSet API is internal at the moment.
Comment 14 Eugene Kuleshov CLA 2005-11-10 10:03:18 EST
(In reply to comment #13)
> No, Subclipse does not yet support change sets yet.  There are no technical
> reasons why it couldn't be added though.  In Subversion each revision is in
> effect a changeset.

They are saying that they not very interested in this and don't even use sync
view tehmselves. So, I got an ipression that it will stay like this until
something happens or they won't have anything else todo.

> The biggest problem is that the ChangeSet API is internal at the moment.

Brock, can you please open an issue to team plugin for this?
Comment 15 Brock Janiczak CLA 2005-11-11 17:14:40 EST
(In reply to comment #14)
> (In reply to comment #13)
> > No, Subclipse does not yet support change sets yet.  There are no technical
> > reasons why it couldn't be added though.  In Subversion each revision is in
> > effect a changeset.
> 
> They are saying that they not very interested in this and don't even use sync
> view tehmselves. So, I got an ipression that it will stay like this until
> something happens or they won't have anything else todo.

If there was a patch, Mark wouldn't reject it.  The only problem is that he will
not accept anything that introduces a dependency on 3.1 API as Mark is
developing mostly on RAD.  Last night I implemented a change set provider for
subclipse that supports outgoing changesets (the bit required for Mylar).  I
will check it into a branch so it doesn't get lost.  It might also encourage
people to look at adding the checked in changesets.

> 
> > The biggest problem is that the ChangeSet API is internal at the moment.
> 
> Brock, can you please open an issue to team plugin for this?

Done, bug 116084.  I doubt it will get done for 3.2 though.
Comment 16 Eugene Kuleshov CLA 2005-11-12 21:52:40 EST
(In reply to comment #15)
> If there was a patch, Mark wouldn't reject it.  The only problem is that he will
> not accept anything that introduces a dependency on 3.1 API as Mark is
> developing mostly on RAD.  Last night I implemented a change set provider for
> subclipse that supports outgoing changesets (the bit required for Mylar).  I
> will check it into a branch so it doesn't get lost.  It might also encourage
> people to look at adding the checked in changesets.

I wonder if this feature can be distributed as a patch to Subclipse or maybe as
an optional feature with dependency on Eclipse 3.1
Comment 17 Mik Kersten CLA 2005-11-22 21:04:27 EST
It's disappointing that bug 116084 indicates that Change Set support isn't likely to be made APIs for 3.2.  So I wonder if Eugene's suggestion of having an seperate or optional Subclipse plug-in that has the 3.1 internal API dependancy.  Note that you could consider making this an optional dependancy, and try to fail gracefully if it isn't satisfied.

Require-Bundle: org.eclipse.ui,
 org.eclipse.team.ui;bundle-version="[3.1.0,4.0.0)";resolution:=optional,