Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 356454 - Offer a simple way to update the project's description
Summary: Offer a simple way to update the project's description
Status: RESOLVED WONTFIX
Alias: None
Product: Community
Classification: Eclipse Foundation
Component: Git (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Thanh Ha CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-09-01 07:43 EDT by Aaron Digulla CLA
Modified: 2021-12-20 12:22 EST (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Aaron Digulla CLA 2011-09-01 07:43:32 EDT
The page http://git.eclipse.org/c/ shows a description per project but there is no simple way to change that.

Either:

- Display the value of the <comment> element in the .project file of the project
- Display the content of a .description file in the project root.
- Create a web page where committers can change descriptions

Discussion:

I like the idea of using the neglected comment element in the .project file but this has two drawbacks:

1. The only way to edit the element is by opening the .project file in an XML or Text editor; the Eclipse IDE offers no specific editor for that (for example in the project properties).

2. Do all projects in Git have a .project file in the git root? Maybe there are projects where it doesn't make sense to have such a file. I don't think it would break anything, though.

The advantage is that we wouldn't need to introduce yet another file.

.description would solve those issues but it would introduce a new file in every project and the name might conflict with something.
Comment 1 Eclipse Webmaster CLA 2011-09-01 09:16:47 EDT
The text is fetched from the 'description' file within the repository root.  All that needs to be done to change it is have the PL login via ssh and edit that file. 

I'm not sure how it could be easier.

-M.
Comment 2 Aaron Digulla CLA 2011-09-01 10:12:44 EDT
It would be easier if I could edit the description in my clone of the project and push it with `git push` :-) No need to bother the PL about it, no need to ssh into a remote computer, find an editor there that I'm know how to use, and the text would be versioned, too, plus every clone would contain the description (just in case I wonder what it is when I stumble upon it on my hard disk).

A simple commit hook would copy the file when a new version is pushed.
Comment 3 Denis Roy CLA 2011-09-06 12:32:28 EDT
I'm honestly surprised git doesn't make this easier...
Comment 4 Aaron Digulla CLA 2011-09-07 03:07:35 EDT
Same with Mercurial - the description is part of a file in .hg but which isn't part of the repository...
Comment 5 Denis Roy CLA 2011-09-07 09:28:54 EDT
I'll reopen this because I think using a hook to solve this problem is a good idea.
Comment 6 Denis Roy CLA 2014-05-07 16:21:58 EDT
Thanh, any ideas here, keeping Gerrit in mind... ?
Comment 7 Thanh Ha CLA 2014-05-07 16:45:30 EDT
(In reply to Denis Roy from comment #6)
> Thanh, any ideas here, keeping Gerrit in mind... ?

We discussed this months ago but I forget where / which bug. Basically it is possible in Gerrit via the Owner permission [1]. However owner gives a little more control over the repo than just modifying descriptions.

Project Owners can also create/delete branches through the WebUI (still blocked via ssh and git though) and Grant/Revoke Owner permissions to others.


I believe at the time we thought the additional permissions were too permissive so we decided to not allow it.


[1] https://git.eclipse.org/r/Documentation/access-control.html#category_owner
Comment 8 Thanh Ha CLA 2014-05-07 16:49:46 EDT
I will look into opening a bug with Gerrit to see if they can make a more fine tuned permission to allow only changing the description. I think this would be ideal.
Comment 9 Denis Roy CLA 2014-05-08 09:22:23 EDT
> I will look into opening a bug with Gerrit

That would be ideal for Gerrit, but wouldn't work for pure Git though.

I was thinking more outside the box, such as what Aaron suggested in comment 2.  If we support something like a "description" file in the root of the repo, we can automate pulling that in and actually using it for the description.
Comment 10 Denis Roy CLA 2014-05-08 09:22:47 EDT
... or it could be a field in PMI, since projects must list their repos there.
Comment 11 Thanh Ha CLA 2014-05-08 09:30:16 EDT
(In reply to Denis Roy from comment #9)
> > I will look into opening a bug with Gerrit
> 
> That would be ideal for Gerrit, but wouldn't work for pure Git though.
> 

Gerrit's UI takes over the description file (or it used to) but looks like a bug in the latest version 2.8.3 that causes it to not update the description file any more when you edit it from Gerrit.
Comment 12 Thanh Ha CLA 2014-05-08 09:31:25 EDT
(In reply to Thanh Ha from comment #11)
> (In reply to Denis Roy from comment #9)
> > > I will look into opening a bug with Gerrit
> > 
> > That would be ideal for Gerrit, but wouldn't work for pure Git though.
> > 
> 
> Gerrit's UI takes over the description file (or it used to) but looks like a
> bug in the latest version 2.8.3 that causes it to not update the description
> file any more when you edit it from Gerrit.

Forgot to link to the bug: http://code.google.com/p/gerrit/issues/detail?id=2568
Comment 13 Denis Roy CLA 2014-05-08 09:32:23 EDT
I've changed my mind.

Having an easy way for committers to do this in Gerrit would be a nice carrot for convincing projects to use Gerrit.

Let's focus on a Gerrit solution.
Comment 14 Thanh Ha CLA 2014-05-26 17:08:24 EDT
Looks like they fixed this in Gerrit 2.9 so we should be able to pull it in when we update.
Comment 15 Denis Roy CLA 2021-12-20 12:22:01 EST
We won't be investing any resources into this aspect of our infra, as it is either deprecated, or it will be soon.

We encourage projects to migrate to GitHub or Eclipse GitLab (https://gitlab.eclipse.org).

Please see: Eclipse Foundation service cleanup superbug
https://bugs.eclipse.org/bugs/show_bug.cgi?id=577150