Bug 1780426 - Review Request: python-sphinx-copybutton - Add a copy button to code cells in Sphinx docs
Summary: Review Request: python-sphinx-copybutton - Add a copy button to code cells in...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Vasiliy Glazov
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-12-06 00:00 UTC by Jerry James
Modified: 2019-12-19 01:23 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-12-19 01:23:12 UTC
Type: ---
Embargoed:
vascom2: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2019-12-06 00:00:00 UTC
Spec URL: https://jjames.fedorapeople.org/python-sphinx-copybutton/python-sphinx-copybutton.spec
SRPM URL: https://jjames.fedorapeople.org/python-sphinx-copybutton/python-sphinx-copybutton-0.2.6-1.fc32.src.rpm
Fedora Account System Username: jjames
Description: Sphinx-copybutton does one thing: add a little "copy" button to the right of your code blocks.  If the code block overlaps to the right of the text area, you can just click the button to get the whole thing.

Comment 1 Vasiliy Glazov 2019-12-06 06:30:35 UTC
1. Subpackage doc must require main package with license file.

Comment 2 Jerry James 2019-12-06 16:30:21 UTC
Thank you, Vasiliy.  The doc subpackage does not actually need the main package, so instead I have added the LICENSE file to the subpackage.  New URLs:

Spec URL: https://jjames.fedorapeople.org/python-sphinx-copybutton/python-sphinx-copybutton.spec
SRPM URL: https://jjames.fedorapeople.org/python-sphinx-copybutton/python-sphinx-copybutton-0.2.6-2.fc32.src.rpm

Comment 3 Vasiliy Glazov 2019-12-06 17:09:32 UTC
OK.
I will finish review tomorrow.

Comment 4 Vasiliy Glazov 2019-12-09 06:53:38 UTC
Approved.

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

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



===== 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. No licenses found. Please check the source files for
     licenses manually.
[x]: License file installed when any subpackage combination is installed.
[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.
[x]: 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).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[x]: 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.
[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 10240 bytes in 1 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: No rpmlint messages.
[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 does not own files or directories owned by other packages.
[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

Python:
[x]: Binary eggs must be removed in %prep
     Note: Cannot find any build in BUILD directory (--prebuilt option?)
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files

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

Generic:
[x]: 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]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-sphinx-copybutton
[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.
[x]: 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.
[-]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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.
[x]: Spec use %global instead of %define unless justified.

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

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-sphinx-copybutton-0.2.6-2.fc32.noarch.rpm
          python-sphinx-copybutton-doc-0.2.6-2.fc32.noarch.rpm
          python-sphinx-copybutton-0.2.6-2.fc32.src.rpm
3 packages and 0 specfiles checked; 0 errors, 0 warnings.




Rpmlint (installed packages)
----------------------------
python-sphinx-copybutton-doc.noarch: W: invalid-url URL: https://sphinx-copybutton.readthedocs.io/en/latest/ <urlopen error [Errno -2] Name or service not known>
python3-sphinx-copybutton.noarch: W: invalid-url URL: https://sphinx-copybutton.readthedocs.io/en/latest/ <urlopen error [Errno -2] Name or service not known>
2 packages and 0 specfiles checked; 0 errors, 2 warnings.



Source checksums
----------------
https://github.com/choldgraf/sphinx-copybutton/archive/a335f3ee70bcdf442204ead0c95f48a39ea70097/sphinx-copybutton-a335f3e.tar.gz :
  CHECKSUM(SHA256) this package     : 116a1a83555cc2489fc9645e248416bd8317edf9e4045b9dc5c7a1cccb35d3e5
  CHECKSUM(SHA256) upstream package : 116a1a83555cc2489fc9645e248416bd8317edf9e4045b9dc5c7a1cccb35d3e5


Requires
--------
python3-sphinx-copybutton (rpmlib, GLIBC filtered):
    python(abi)
    python3.8dist(sphinx)

python-sphinx-copybutton-doc (rpmlib, GLIBC filtered):



Provides
--------
python3-sphinx-copybutton:
    python-sphinx-copybutton
    python3-sphinx-copybutton
    python3.8dist(sphinx-copybutton)
    python3dist(sphinx-copybutton)

python-sphinx-copybutton-doc:
    python-sphinx-copybutton-doc



Generated by fedora-review 0.7.3 (44b83c7) last change: 2019-09-18
Command line :/usr/bin/fedora-review -b 1780426
Buildroot used: fedora-rawhide-{{ target_arch }}
Active plugins: Generic, Shell-api, Python
Disabled plugins: PHP, Java, SugarActivity, Ocaml, Perl, C/C++, Haskell, R, fonts
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 5 Jerry James 2019-12-09 22:31:46 UTC
Thank you very much for the review, Vasiliy!

Comment 6 Gwyn Ciesla 2019-12-09 22:45:33 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-sphinx-copybutton

Comment 7 Fedora Update System 2019-12-10 15:25:36 UTC
FEDORA-2019-6f877b61a6 has been submitted as an update to Fedora 31. https://bodhi.fedoraproject.org/updates/FEDORA-2019-6f877b61a6

Comment 8 Fedora Update System 2019-12-11 01:41:53 UTC
python-sphinx-copybutton-0.2.6-2.fc31 has been pushed to the Fedora 31 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2019-6f877b61a6

Comment 9 Fedora Update System 2019-12-19 01:23:12 UTC
python-sphinx-copybutton-0.2.6-2.fc31 has been pushed to the Fedora 31 stable repository. If problems still persist, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.