Ticket #9004 (closed defect: invalid)

Opened 2 years ago

Last modified 1 year ago

[PATCH] Does not have a link to the comment that generated the email

Reported by: rjollos Assigned to: doki_pen
Priority: normal Component: AnnouncerPlugin
Severity: normal Keywords:
Cc: hasienda Trac Release: 0.12

Description

Trac notifications contain a link to the ticket comment that generated the email:

Announcer notifications only contain a link to the ticket:

Attachments

AnnouncerNotification.png (9.1 kB) - added by rjollos on 07/19/11 19:57:26.
TracNotification.png (6.9 kB) - added by rjollos on 07/19/11 19:57:42.
announcerplugin-comment-in-ticket-link.patch (2.5 kB) - added by bof on 07/25/11 18:26:37.
append #comment:N to ticket link in notification mails

Change History

07/19/11 19:57:26 changed by rjollos

  • attachment AnnouncerNotification.png added.

07/19/11 19:57:42 changed by rjollos

  • attachment TracNotification.png added.

07/25/11 18:23:40 changed by bof

  • summary changed from Does not have a link to the comment that generated the email to [PATCH] Does not have a link to the comment that generated the email.

That detail also made me uncomfortable, when trying out the AnnouncerPlugin.

Today I made a patch which for me fixes the issue. Patch follows, against 0.11/ subversion tree, tested on Trac 0.11.7.

07/25/11 18:26:37 changed by bof

  • attachment announcerplugin-comment-in-ticket-link.patch added.

append #comment:N to ticket link in notification mails

07/26/11 09:24:59 changed by rjollos

This patch looks pretty good to me. Use of cnum will result in the issues described in #6930 and #6535, but I think we have no other option on 0.11, and the author has handled the issue appropriately with a try/catch when querying cnum.

This patch should only be applied to the 0.11 branch and this issue handled differently in 0.12 and beyond right? I haven't looked closely at the implementation in 0.12, but Osimons comments in #6930 and a close look at the th:TracDev/DatabaseSchema should show us the way ...

I'll test it out in the morning and make a couple of style comments, and then maybe we can get it applied pending some feedback from hasienda or doki_pen.

07/26/11 09:41:15 changed by rjollos

  • cc set to hasienda.

09/17/11 22:06:45 changed by rjollos

I've tested this patch on my Trac 0.11.7 instance, running the latest 0.11 branch (r10458) of the AnnouncerPlugin. The patch works well.

I'd appreciate if someone with more Trac experience could give this a review and decide if it is appropriate to push to the trunk or even just the 0.11 branch. hasienda or doki_pen?

02/02/12 08:02:36 changed by rjollos

  • status changed from new to closed.
  • resolution set to invalid.

The trunk has an option ticket_change_with_comment that is False by default. After setting to true, the comment is appended to the URL at the end of the email. I'd suggest setting this option to true by default, in order to mimic the behavior of Trac.

02/02/12 08:07:56 changed by rjollos

(In [11231]) Refs #9004: Minor wording correction to option description.

02/02/12 08:15:28 changed by rjollos

  • release changed from 0.11 to 0.12.

02/02/12 08:44:10 changed by rjollos

I originally reported this against 0.11. I'm on 0.12 now. The option is also available on the 0.11.2dev branch, but doesn't look to be available on the 0.11 branch. I haven't tested either of those, just looked at the source code. The trunk should eventually be backported to 0.11 anyway.

This option is not shown on the Trac wiki page. In the past I would always look to project wiki pages to determine the available options. Then, after developing for a while, I realized I should be looking at the TracIni page after installation to discover the available options. I think many newcomers to Trac do the same, and fail to realize the best place to look for documentation of options is usually the TracIni page.

Now, I tend to think that TracIni is a better place for documentation because it is more likely to be accurate, as opposed to the project's wiki page which may be out of date. I have a dream of writing a plugin for Trac-Hacks that pulls documentation from the source code and displays it on the project's wiki page, but that is just a dream for now ;)

For now, I try to watch the RSS and direct new users to the TracIni page. Occasionally, I put an explicit statement on the project wiki page, as I've done here:

/wiki/AnnouncerPlugin?action=diff&version=60

Add/Change #9004 ([PATCH] Does not have a link to the comment that generated the email)




Change Properties
Action