(release notes generator) Do we need to worry about attachment?

[Chris Johns]

Hi,

For the record this topic was resolved in our meeting.

Attachments will not be inlined in the release notes and a link where possible
will be provided. Expansion of links to inline them is problematic because of
dependencies, size and varying formats, for example how do you place a
compressed tar file in release notes.

Chris

On 31/5/18 6:17 am, Joel Sherrill wrote:
> 
> 
> On Wed, May 30, 2018 at 9:00 AM, Gedare Bloom <gedare at rtems.org
> <mailto:gedare at rtems.org>> wrote:
> 
>     On Tue, May 29, 2018 at 5:14 PM, Chris Johns <chrisj at rtems.org
>     <mailto:chrisj at rtems.org>> wrote:
>     > On 30/5/18 5:30 am, Dannie Huang wrote:
>     >> I am now able to grab most of needed information from ticket's page by using
>     >> python (like ticket id, description, comments, etc).
>     >
>     > Fantastic.
>     >
>     >> There is a place for
>     >> attachment on a ticket's page, do we also need to get the information of
>     >> attached files? If we need to, how can I implement?
>     >
>     > I suggest we include a link a reader of the Release Notes can click on. I
>     > suppose this means recording a link when parsing the data from the feed.
>     >
> 
>     Usually, the attachment is a patch. If the ticket is closed, it should
>     mean there is a commit available correspondingly. I'm not sure what
>     use the attachment would be in release notes. Making it a link
>     shouldn't hurt anything though, I suppose.
> 
> 
> Putting on my user hat, I wouldn't want a patch itself in the release notes.
> A link would be more useful.
> 
> I am thinking there are at least four URL patterns. 
> 
> A URL included in the text like a link to the Open Group.
> One is a git hash that's a clickable link 
> Another is {{...}} with some git stuff in it. 
> And links to attachments.
> 
> Are there other places URLs show up?
> 
> --joel
>  
> 
> 
>     > Chris
>     > _______________________________________________
>     > devel mailing list
>     > devel at rtems.org <mailto:devel at rtems.org>
>     > http://lists.rtems.org/mailman/listinfo/devel
>     <http://lists.rtems.org/mailman/listinfo/devel>
>     _______________________________________________
>     devel mailing list
>     devel at rtems.org <mailto:devel at rtems.org>
>     http://lists.rtems.org/mailman/listinfo/devel
>     <http://lists.rtems.org/mailman/listinfo/devel>
> 
>