New Golang Packaging Guidelines: Feedback needed and appreciated

[Robert-André Mauchin]

Hello Fedora people,

    As you may or may not know, currently applied Golang packaging guidelines 
have always been simply a « draft ». Part of the new Go SIG mission is to 
update ours best practices and tooling. As such, Nicolas Mailhot designed  a 
new set of macros based on lua script to improve our current situation. As a 
result, we needed to draft new guidelines to reflect the future implementation 
of these macros.

    I have written these new guidelines and I'd like to ask for your help in 
order to review them: both from current Go SIG packagers point of view and 
from novices in the matter, in order to make sure they are clear and 
understandable enough for everyone.

    I have uploaded a mirror of the Guidelines on my FedoraPeople space:
https://eclipseo.fedorapeople.org/guidelines/packaging-guidelines/Golang/

    Please, if you have 10 mn to spare, read them and send me feedback. If you 
wish you can also directly send me a Merge Request on Pagure:
https://pagure.io/fork/eclipseo/packaging-committee/  (branch 
implement_golang_guidelines).

Best regards,

Robert-André

[Jakub Cajka]

----- Original Message -----
>  From: "Robert-André Mauchin" <zebob.m(a)gmail.com&gt;
>  To: devel(a)lists.fedoraproject.org
>  Cc: "nicolas mailhot" <nicolas.mailhot(a)laposte.net&gt;,
> golang(a)lists.fedoraproject.org, jcajka(a)redhat.com, "Discussion
>  of RPM packaging standards and practices for Fedora"
> <packaging(a)lists.fedoraproject.org&gt;
>  Sent: Friday, March 22, 2019 7:46:23 PM
>  Subject: New Golang Packaging Guidelines: Feedback needed and appreciated
>  
>  Hello Fedora people,
>  
>      As you may or may not know, currently applied Golang packaging guidelines
>  have always been simply a « draft ». Part of the new Go SIG mission is to
>  update ours best practices and tooling. As such, Nicolas Mailhot designed  a
>  new set of macros based on lua script to improve our current situation. As a
>  result, we needed to draft new guidelines to reflect the future
>  implementation
>  of these macros.
>  
>      I have written these new guidelines and I'd like to ask for your help in
>  order to review them: both from current Go SIG packagers point of view and
>  from novices in the matter, in order to make sure they are clear and
>  understandable enough for everyone.
>  
>      I have uploaded a mirror of the Guidelines on my FedoraPeople space:
>  https://eclipseo.fedorapeople.org/guidelines/packaging-guidelines/Golang/
>  
>      Please, if you have 10 mn to spare, read them and send me feedback. If
>      you
>  wish you can also directly send me a Merge Request on Pagure:
>  https://pagure.io/fork/eclipseo/packaging-committee/  (branch
>  implement_golang_guidelines).
>  
>  Best regards,
>  
>  Robert-André
>   
Thanks, great work.

I unfortunately I have managed to just go trough roughly half of them, but they look great
so far. There some parts that needs minor fix up, some a bit of expanding and IMO there
are some that can be omitted with just pointer to the general guidelines.

I hope that I will be able to send some PRs and open some issue/enhancement requests by
the next week. Also I will try to ask someone from the Fedora docs team to take a look at
the non-technical side of the things.

Thanks again for writing the new guidelines draft,

JC

> 
> _______________________________________________
> golang mailing list -- golang(a)lists.fedoraproject.org
> To unsubscribe send an email to golang-leave(a)lists.fedoraproject.org
> Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html
> List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
> List Archives:
> https://lists.fedoraproject.org/archives/list/[e-mail]
>

[David Dykstra]

Robert,

I'd like to see clarity on the guidelines for golang applications as
opposed to golang libraries.  It seems to assume from the start that
it's talking about libraries, based on the package naming requirement.
In the "Bundled or de-bundled" section I see mention of "golang
projects"
and I suppose that's the name given to what I'm talking about.  It's
hard to tell how much of the guidelines apply to a golang project.

Dave
(singularity package owner)

On Fri, Mar 22, 2019 at 07:46:23PM +0100, Robert-André Mauchin wrote:
> Hello Fedora people,
> 
>     As you may or may not know, currently applied Golang packaging guidelines 
> have always been simply a «???draft???». Part of the new Go SIG mission is to 
> update ours best practices and tooling. As such, Nicolas Mailhot designed  a 
> new set of macros based on lua script to improve our current situation. As a 
> result, we needed to draft new guidelines to reflect the future implementation 
> of these macros.
> 
>     I have written these new guidelines and I'd like to ask for your help in 
> order to review them: both from current Go SIG packagers point of view and 
> from novices in the matter, in order to make sure they are clear and 
> understandable enough for everyone.
> 
>     I have uploaded a mirror of the Guidelines on my FedoraPeople space:
> https://eclipseo.fedorapeople.org/guidelines/packaging-guidelines/Golang/
> 
>     Please, if you have 10 mn to spare, read them and send me feedback. If you 
> wish you can also directly send me a Merge Request on Pagure:
> https://pagure.io/fork/eclipseo/packaging-committee/  (branch 
> implement_golang_guidelines).
> 
> Best regards,
> 
> Robert-André
> 
> 
> _______________________________________________
> devel mailing list -- devel(a)lists.fedoraproject.org
> To unsubscribe send an email to devel-leave(a)lists.fedoraproject.org
> Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html
> List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
> List Archives:
https://lists.fedoraproject.org/archives/list/[e-mail]

[Nicolas Mailhot]

Le mercredi 27 mars 2019 à 19:13 +0000, David Dykstra a écrit :
Hi David,
>  
>  I'd like to see clarity on the guidelines for golang applications as
>  opposed to golang libraries.  It seems to assume from the start that
>  it's talking about libraries, based on the package naming
>  requirement. 
From a technical POW and given how the Go world is structured a Golang
application is just another bundle of Go source code, that happens to
produce binaries.

So all the Go source code packaging guidelines apply as-is, except for
the srpm naming, and the fact that %build also produces binaries that
need to be deployed somewhere on the filesystem (but once compiled,
there is no specific difference between a Go or a C binary from a
packaging POW, so you won't find long Go-binary specific explanations
here).



-- 
Nicolas Mailhot