[release notes] Linking to github issues/pull requests

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|

[release notes] Linking to github issues/pull requests

Boost - Dev mailing list
Hi,

I've added templates for linking to github issues and pull requests
from the release notes. There are two templates:

[github module number] which expands to '#number'
[github_pr module number] which expands to 'PR#number'.

Both will be linked, they need the name of the module to link to the
right place.

We only really need the issue template as github redirects to the pull
request if appropriate, but existing release notes have been using the
PR#3 format, so I thought it should support that.

You can see an example in the unordered release notes for 1.67.0:

https://github.com/boostorg/website/blob/master/feed/history/boost_1_67_0.qbk
http://www.boost.org/users/history/in_progress.html

Does that look okay?

Daniel

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
On 12.01.2018 06:36, Daniel James via Boost wrote:

> Hi,
>
> I've added templates for linking to github issues and pull requests
> from the release notes. There are two templates:
>
> [github module number] which expands to '#number'
> [github_pr module number] which expands to 'PR#number'.
>
> Both will be linked, they need the name of the module to link to the
> right place.
>
> We only really need the issue template as github redirects to the pull
> request if appropriate, but existing release notes have been using the
> PR#3 format, so I thought it should support that.
>
> You can see an example in the unordered release notes for 1.67.0:
>
> https://github.com/boostorg/website/blob/master/feed/history/boost_1_67_0.qbk
> http://www.boost.org/users/history/in_progress.html
>
> Does that look okay?

Anything that increases the coupling between boost projects worries me.
I think this proposal would work much better if it was used to generate
per-project release notes. Nothing speaks against linking to per-project
release-notes from a single boost release document. but the logic to
syndicate that information shouldn't lead to more coupling.

Stefan

--

      ...ich hab' noch einen Koffer in Berlin...
   


_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
In reply to this post by Boost - Dev mailing list


> -----Original Message-----
> From: Boost [mailto:[hidden email]] On Behalf Of Daniel James via Boost
> Sent: 12 January 2018 11:36
> To: [hidden email]
> Cc: Daniel James
> Subject: [boost] [release notes] Linking to github issues/pull requests
>
> Hi,
>
> I've added templates for linking to github issues and pull requests
> from the release notes. There are two templates:
>
> [github module number] which expands to '#number'
> [github_pr module number] which expands to 'PR#number'.
>
> Both will be linked, they need the name of the module to link to the
> right place.
>
> We only really need the issue template as github redirects to the pull
> request if appropriate, but existing release notes have been using the
> PR#3 format, so I thought it should support that.
>
> You can see an example in the unordered release notes for 1.67.0:
>
> https://github.com/boostorg/website/blob/master/feed/history/boost_1_67_0.qbk
> http://www.boost.org/users/history/in_progress.html
>
> Does that look okay?

Perfect :-)

Thanks

Paul

PS Just needs adding

[github module number] which expands to '#number'
[github_pr module number] which expands to 'PR#number'.

and an example like the above

to the Quickbook docs ;-)

And get people to use it too (the difficult bit!).

---
Paul A. Bristow
Prizet Farmhouse
Kendal UK LA8 8AB
+44 (0) 1539 561830






_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
On 01/12/18 15:28, Paul A. Bristow via Boost wrote:

>
>
>> -----Original Message-----
>> From: Boost [mailto:[hidden email]] On Behalf Of Daniel James via Boost
>> Sent: 12 January 2018 11:36
>> To: [hidden email]
>> Cc: Daniel James
>> Subject: [boost] [release notes] Linking to github issues/pull requests
>>
>> Hi,
>>
>> I've added templates for linking to github issues and pull requests
>> from the release notes. There are two templates:
>>
>> [github module number] which expands to '#number'
>> [github_pr module number] which expands to 'PR#number'.
>>
>> Both will be linked, they need the name of the module to link to the
>> right place.
>>
>> We only really need the issue template as github redirects to the pull
>> request if appropriate, but existing release notes have been using the
>> PR#3 format, so I thought it should support that.
>>
>> You can see an example in the unordered release notes for 1.67.0:
>>
>> https://github.com/boostorg/website/blob/master/feed/history/boost_1_67_0.qbk
>> http://www.boost.org/users/history/in_progress.html
>>
>> Does that look okay?
>
> Perfect :-)
>
> Thanks
>
> Paul
>
> PS Just needs adding
>
> [github module number] which expands to '#number'
> [github_pr module number] which expands to 'PR#number'.
>
> and an example like the above
>
> to the Quickbook docs ;-)
>
> And get people to use it too (the difficult bit!).

As far as I understand, this is not a builtin Quickbook feature. Those
templates (and [ticket number] as well) are defined by the release notes
infrastructure.

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
In reply to this post by Boost - Dev mailing list
On 01/12/18 14:36, Daniel James via Boost wrote:

> Hi,
>
> I've added templates for linking to github issues and pull requests
> from the release notes. There are two templates:
>
> [github module number] which expands to '#number'
> [github_pr module number] which expands to 'PR#number'.
>
> Both will be linked, they need the name of the module to link to the
> right place.
>
> We only really need the issue template as github redirects to the pull
> request if appropriate, but existing release notes have been using the
> PR#3 format, so I thought it should support that.
>
> You can see an example in the unordered release notes for 1.67.0:
>
> https://github.com/boostorg/website/blob/master/feed/history/boost_1_67_0.qbk
> http://www.boost.org/users/history/in_progress.html
>
> Does that look okay?

Looks good, although I would prefer if Trac tickects could be
distinguished from GitHub issues. Maybe expand issues to GH#number?

Thanks for the enhancement, anyway. :)

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
In reply to this post by Boost - Dev mailing list
On 01/12/18 15:23, Stefan Seefeld via Boost wrote:

> On 12.01.2018 06:36, Daniel James via Boost wrote:
>> Hi,
>>
>> I've added templates for linking to github issues and pull requests
>> from the release notes. There are two templates:
>>
>> [github module number] which expands to '#number'
>> [github_pr module number] which expands to 'PR#number'.
>>
>> Both will be linked, they need the name of the module to link to the
>> right place.
>>
>> We only really need the issue template as github redirects to the pull
>> request if appropriate, but existing release notes have been using the
>> PR#3 format, so I thought it should support that.
>>
>> You can see an example in the unordered release notes for 1.67.0:
>>
>> https://github.com/boostorg/website/blob/master/feed/history/boost_1_67_0.qbk
>> http://www.boost.org/users/history/in_progress.html
>>
>> Does that look okay?
>
> Anything that increases the coupling between boost projects worries me.
> I think this proposal would work much better if it was used to generate
> per-project release notes. Nothing speaks against linking to per-project
> release-notes from a single boost release document. but the logic to
> syndicate that information shouldn't lead to more coupling.

Just providing links to project-specific release notes is not enough,
IMO. I would prefer aggregated release notes to be readable in one
place, even if they are collected from project-specific sources.
Although I don't see much problem with the current setup as well.

In any case, that is a completely different piece of work from what
Daniel have done.

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
In reply to this post by Boost - Dev mailing list
On 12 January 2018 at 12:35, Andrey Semashev via Boost
<[hidden email]> wrote:
>
> Looks good, although I would prefer if Trac tickects could be distinguished
> from GitHub issues. Maybe expand issues to GH#number?

I don't think GH would be as obvious as PR. Maybe GitHub#number would
be better? I was following the existing release notes were people have
just used #number. It's not that confusing as the numbers are much
lower than they are for trac, and the links go to the right place.

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
On 01/13/18 19:43, Daniel James via Boost wrote:
> On 12 January 2018 at 12:35, Andrey Semashev via Boost
> <[hidden email]> wrote:
>>
>> Looks good, although I would prefer if Trac tickects could be distinguished
>> from GitHub issues. Maybe expand issues to GH#number?
>
> I don't think GH would be as obvious as PR. Maybe GitHub#number would
> be better?

GitHub#number is ok, too. I wanted the prefix to be short, if possible,
so that the issue numbers don't clutter the rest of the text too much,
especially if there are many references.

> I was following the existing release notes were people have
> just used #number. It's not that confusing as the numbers are much
> lower than they are for trac, and the links go to the right place.

Yeah, it's not a strong preference of mine, as I can always see where
the link leads to. Just something that I would do in my release notes.
It's fine if you decide to leave it without a prefix.

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Reply | Threaded
Open this post in threaded view
|

Re: [release notes] Linking to github issues/pull requests

Boost - Dev mailing list
In reply to this post by Boost - Dev mailing list
On Fri, Jan 12, 2018 at 3:36 AM, Daniel James via Boost
<[hidden email]> wrote:
> I've added templates for linking to github issues and pull requests
> from the release notes. There are two templates:

Thank you, this will be very helpful for Beast as I rely heavily on
GitHub to interact with users, and the upcoming release notes for
Beast will be massive.

Regards

_______________________________________________
Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost