From Fedora Project Wiki

Adopt new Go Packaging Guidelines

Summary

The current Go packaging guidelines have been in a draft state for several years now, and they do not reflect the current practices from the Go SIG. As a result of new RPM macros developed by Nicolas Mailhot, the Go SIG wishes to formally adopt new Go Packaging Guidelines, which aim at automation, reliability and simplicity.

This proposal consists of:

  • Packaging the new Go macros: go-rpm-macros
  • Getting the Guidelines approved by the FPC
  • Updating all Go libraries with the new macros
  • Mass-rebuilding all the Go package in a side tag

Owner

  • Email: <golang@lists.fedoraproject.org>
  • Release notes owner:

Current status

  • Targeted release: Fedora 31
  • Last updated: 2019-04-24
  • Tracker bug: <will be assigned by the Wrangler>

Detailed Description

Over 775 Go packages are currently residing in Fedora's repositories, yet no formal guidelines have ever been approved. As a result, the various Go SPECs are inconsistent and most often outdated. Moreover, the next version of Go, 1.13, will introduce the concept of modules by default, which will completely change how Go libraries are distributed. With the current state of our tooling, the Go SIG is not prepared to face such a drastic change.

Nicolas Mailhot has worked on a set of new RPM macros which will allow us to disconnect the upstream Go tooling from the downstream integration inside RPM. This will allow us to adapt easily to future upstream changes without the need to rewrite our SPEC catalogue.

Benefit to Fedora

  • Simplicity: SPEC files are simpler, less error-prone
  • Automation: the new macros computes packages definition, Requires, Provides and has provision for the new automated BuildRequires
  • Standardization of SPEC files across the Go library
  • Drastic reduction of boilerplate and SPEC size
  • Automatic removal of vendored code
  • Ease of testing: all units tests are detected and run
  • Ease of upkeep
  • Ease of adaptation to upstream changes

Scope

  • Other developers: N/A (not a System Wide Change)
  • Release engineering: Mass-rebuild Go packages in a side tag before Change deadline

Upgrade/compatibility impact

No compatibility impact is expected. All the new macros are backward compatible with the old ones.

How To Test

The COPR nim/macros-ng can be used to test the new macros on Rawhide. Sample SPEC files are available in the FPC Guidelines proposal. The COPR eclipseo/golang-ng/ contains the work in progress of Go packages update.

User Experience

The user impact is minimal or nil. As a result of the simplification of SPEC files, we may ship updated libraries more quickly, and it may be easier for new contributors to package Go applications.

Dependencies

N/A (not a System Wide Change)

Contingency Plan

  • Contingency mechanism: If the required packages are not merged by the deadline target, or if the Guidelines are not approved, we may continue with our current set of non-approved practices. No other impact is expected.
  • Contingency deadline: N/A (not a System Wide Change)
  • Blocks release? No
  • Blocks product? No

Documentation

The FPC Guidelines proposal is available on eclipseo personal space.

Release Notes

  • Release Notes tracking: #TBD