[Bug 1770566] Review Request: gron - Make JSON greppable

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



https://bugzilla.redhat.com/show_bug.cgi?id=1770566



--- Comment #2 from Dusty Mabe <dustymabe@xxxxxxxxxx> ---

Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated

===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: There is no build directory. Running licensecheck on vanilla
     upstream sources. Licenses found: "Unknown or generated". 1 files have
     unknown license. Detailed output of licensecheck in
     /home/vagrant/review/1770566-gron/licensecheck.txt
[x]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/share/doc/gron(locale,,
     to, C, Failed, set, defaulting), /usr/share/licenses/gron(locale,, to,
     C, Failed, set, defaulting)
[-]: %build honors applicable compiler flags or justifies otherwise.

It might be good to use %gobuild for this:

https://docs.fedoraproject.org/en-US/packaging-guidelines/Golang/#_packaging_a_binary_the_build_section


[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[?]: Package is named according to the Package Naming Guidelines.

DWM: It looks like the golang guidlines have recently been published in
the Fedora Docs (they look really nice!). In there I think it says that
go packages must be named in a certain way. For us I think it would be
golang-github-tomnomnom-gron and then we can create a binary package with
the name `gron` as a subpackage:


https://docs.fedoraproject.org/en-US/packaging-guidelines/Golang/#_naming
https://docs.fedoraproject.org/en-US/packaging-guidelines/Golang/#_go_binary_packages

I'll have to lean on one of our go packaging experts for advice here.


[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[!]: Useful -debuginfo package or justification otherwise.

There is no debuginfo package. Maybe one of our go experts can tell us what
macro
we can use to generate those packages.

[x]: Package is not known to require an ExcludeArch tag.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 20480 bytes in 2 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.

Upstream doesn't publish signatures.


[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.

Successfully built in koji on all architectures:
https://koji.fedoraproject.org/koji/taskinfo?taskID=38884058


[!]: %check is present and all tests pass.

DWM: Optional: add a %check section for running tests as part of the build
process.

[x]: Packages should try to preserve timestamps of original installed
     files.
[!]: Spec use %global instead of %define unless justified.
     Note: %define requiring justification: %define debug_package %{nil},
     %define repo github.com/tomnomnom/gron

DWM: Optional: Perhaps you can change these to %global:
https://docs.fedoraproject.org/en-US/packaging-guidelines/#_global_preferred_over_define


[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: gron-0.6.0-1.fc32.x86_64.rpm
          gron-0.6.0-1.fc32.src.rpm
gron.x86_64: W: spelling-error Summary(en_US) greppable -> reparable
gron.x86_64: W: unstripped-binary-or-object /usr/bin/gron
gron.x86_64: W: no-manual-page-for-binary gron
gron.src: W: spelling-error Summary(en_US) greppable -> reparable
2 packages and 0 specfiles checked; 0 errors, 4 warnings.


DWM: For the rpmlint spelling errors.. Greppable isn't a word but it is a
technical term
     so don't worry about it.


A few other items found by Dusty during review:

==== Go Packaging Guidelines ====

https://docs.fedoraproject.org/en-US/packaging-guidelines/Golang/

[!] Packages MUST have BuildRequires: go-rpm-macros. 

    This requirement is defined here:
   
https://docs.fedoraproject.org/en-US/packaging-guidelines/Golang/#_dependencies

    You can solve this by including the %gometa macro:
   
https://docs.fedoraproject.org/en-US/packaging-guidelines/Golang/#_usual_case

-- 
You are receiving this mail because:
You are on the CC list for the bug.
You are always notified about changes to this product and component
_______________________________________________
package-review mailing list -- package-review@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to package-review-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/package-review@xxxxxxxxxxxxxxxxxxxxxxx




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite Conditions]     [KDE Users]

  Powered by Linux