Page MenuHomeSolus

Update 'paperwork-gui' -> 'paperwork' to 2.0.3
ClosedPublic

Authored by maikwoehl on Thu, Sep 9, 12:08 AM.

Details

Summary

Renamed from paperwork-gui to paperwork and bumped to 2.0.3.

Depends on D11824

Fix T9402.

Test Plan

Build test

Build with all dependencies and started.

▶ paperwork-gtk chkdeps
Detected system: solus 4.3 fortitude
[WARNING] [openpaperwork_core.cmd.chkdeps] WARNING: Unknown distribution. Can't suggest packages to install

Functional test

  1. Check locales
  2. Open "Contributions"
  3. Open "Help" Help is downloaded from paperwork's ci, according to make release.
  4. Open PDF-file and test paperwork

Diff Detail

Repository
R2297 paperwork
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

maikwoehl created this revision.Thu, Sep 9, 12:08 AM
maikwoehl requested review of this revision.Thu, Sep 9, 12:08 AM
maikwoehl updated this revision to Diff 28741.Thu, Sep 9, 12:42 AM

Updated .desktop file to have correct version and binary name

maikwoehl updated this revision to Diff 28742.Thu, Sep 9, 12:44 AM

Reset version tag to 1.0 because it isn't the binary version but the specification version.

All the icons and symbols are missing.

I will execute paperwork-gtk chkdeps to find the missing files. (Locales, Icons, Media)

algent added a subscriber: algent.Thu, Sep 9, 8:40 PM

I think I found a way to build icons.

builddeps  :
    - paperwork-backend
    - pyxdg
    - xdg-utils
    - xorg-server-xvfb
rundeps    :
    - paperwork-backend
    - python-dateutil
    - pyxdg
build      : |
    make version
    make l10n_compile
    %make
install    : |
    pushd paperwork-gtk
      %python3_install
    popd

    # install icons and desktop file
    export PYTHONPATH=%installroot%/usr/lib/python%python3_version%/site-packages:$PWD
    xvfb-run -a python3 -m paperwork_gtk.main install \
        --icon_base_dir=$installdir/usr/share/icons \
        --data_base_dir=$installdir/usr/share

Now the .desktop file is included with means you have to delete our paperwork.dekstop.

Still don't know why the version is still reported 0.0.0 /usr/lib/python3.9/site-packages/paperwork-0.0.0-py3.9.egg-info/PKG-INFO
You can see that from pip too. pip3 show paperwork.
But this isn't a big issue. The most important thing here is to test this package and maintain it. :D

Unfortunately this repository and package is named paperwork-gui. Is it possible to rename the package? Or should I create a new one and with "Replace paperwork-gui"?

algent added a comment.Thu, Sep 9, 9:04 PM

Unfortunately this repository and package is named paperwork-gui. Is it possible to rename the package? Or should I create a new one and with "Replace paperwork-gui"?

Yes it is possible to rename this package, but then if accepted you have to submit a PR to deprecate paperwork-gui in solus-sc.
Here is an example how to replace the name: https://dev.getsol.us/source/apostrophe/browse/master/package.yml

maikwoehl added a comment.EditedThu, Sep 9, 9:06 PM

Still don't know why the version is still reported 0.0.0 /usr/lib/python3.9/site-packages/paperwork-0.0.0-py3.9.egg-info/PKG-INFO
You can see that from pip too. pip3 show paperwork.
But this isn't a big issue. The most important thing here is to test this package and maintain it. :D

The version is created from make version in the root directory. And there the version is read from git. But we download the source tarball without git. So there is unfortunately no version available. But we can set it manually be creating the file (uggh :/) or clone the tag with git directly.
https://gitlab.gnome.org/World/OpenPaperwork/paperwork/-/blob/2.0.3/paperwork-gtk/Makefile#L17

maikwoehl updated this revision to Diff 28751.Thu, Sep 9, 10:36 PM

Use algent's package.yml with a version fix

maikwoehl updated this revision to Diff 28752.Thu, Sep 9, 11:56 PM

link missing packages into right location

paperwork-gtk chkdeps returns no missing dependencies.

maikwoehl updated this revision to Diff 28753.Fri, Sep 10, 12:13 AM

Renamed package 'paperwork-gui' -> 'paperwork-gtk'

maikwoehl edited the summary of this revision. (Show Details)Fri, Sep 10, 12:17 AM
maikwoehl edited the test plan for this revision. (Show Details)
maikwoehl retitled this revision from Update paperwork-gui to 2.0.3 to Update 'paperwork-gui' -> 'paperwork-gtk' to 2.0.3 .Fri, Sep 10, 12:19 AM
maikwoehl updated this revision to Diff 28754.Fri, Sep 10, 1:16 AM
maikwoehl retitled this revision from Update 'paperwork-gui' -> 'paperwork-gtk' to 2.0.3 to Update 'paperwork-gui' -> 'paperwork-gtk' to 2.0.3.
maikwoehl edited the summary of this revision. (Show Details)

Cleanup package.yml and use patch for _version.py

maikwoehl retitled this revision from Update 'paperwork-gui' -> 'paperwork-gtk' to 2.0.3 to [RFC] Update 'paperwork-gui' -> 'paperwork-gtk' to 2.0.3.Fri, Sep 10, 1:29 AM

In my opinion, it is better using simply the name paperwork.

Another thing.
You have to use the stack option to link this diff with other diffs.
For example: paperwork-gtk depends on paperwork-backend which is D11824.
Building paperwork-gtk will fail if paperwork-backend is not built first.
In this case, you have to edit the summary and add a new line:
Depends on D11824
The same with paperwork-backend dependencies, openpaperwork-core and openpaperwork-gtk

maikwoehl updated this revision to Diff 28762.Fri, Sep 10, 6:11 PM
maikwoehl retitled this revision from [RFC] Update 'paperwork-gui' -> 'paperwork-gtk' to 2.0.3 to [RFC] Update 'paperwork-gui' -> 'paperwork' to 2.0.3.
maikwoehl edited the summary of this revision. (Show Details)

Rename to paperwork and "Depends on"

Unfortunately the help files are not packaged. For that the Makefiles have the make data target. So I have the make the data in build process. For that I need imagemagick and pdflatex.

maikwoehl edited the test plan for this revision. (Show Details)Sun, Sep 12, 2:27 PM
maikwoehl edited the summary of this revision. (Show Details)Sun, Sep 12, 3:05 PM
maikwoehl edited the test plan for this revision. (Show Details)
maikwoehl updated this revision to Diff 28777.Sun, Sep 12, 5:03 PM
maikwoehl edited the test plan for this revision. (Show Details)

Tried to make data for help files, but the building has cyclic dependency to paperwork-gtk itself.

maikwoehl edited the test plan for this revision. (Show Details)Sun, Sep 12, 5:05 PM
maikwoehl edited the summary of this revision. (Show Details)
maikwoehl edited the test plan for this revision. (Show Details)Sun, Sep 12, 5:25 PM

List of data.tar.gz can be found on https://download.openpaper.work/. There you can find the corresponding tar.gz. file for the version branch/tag.

maikwoehl edited the test plan for this revision. (Show Details)Sun, Sep 12, 5:39 PM
maikwoehl updated this revision to Diff 28781.Sun, Sep 12, 5:59 PM
maikwoehl edited the summary of this revision. (Show Details)

Separated docs subpackage

maikwoehl updated this revision to Diff 28858.Fri, Sep 17, 4:57 PM

Add MAINTAINERS.md

joebonrichie requested changes to this revision.Sat, Sep 18, 11:57 AM
joebonrichie added a subscriber: joebonrichie.

Can you now remove [RFC] from the entire stack. Looks in generally good shape now.

This revision now requires changes to proceed.Sat, Sep 18, 11:57 AM
maikwoehl retitled this revision from [RFC] Update 'paperwork-gui' -> 'paperwork' to 2.0.3 to Update 'paperwork-gui' -> 'paperwork' to 2.0.3.Mon, Sep 20, 4:47 PM
maikwoehl requested review of this revision.Mon, Sep 20, 7:35 PM

They are retitled.

joebonrichie accepted this revision.Sat, Sep 25, 12:12 PM
This revision is now accepted and ready to land.Sat, Sep 25, 12:12 PM
This revision was automatically updated to reflect the committed changes.

The repo is renamed now to paperwork. Please fix the whitespace issue so the old eopkg can be deprecated asap please. https://github.com/getsolus/solus-sc/pull/104

The repo is renamed now to paperwork. Please fix the whitespace issue so the old eopkg can be deprecated asap please. https://github.com/getsolus/solus-sc/pull/104

Whitespace is fixed and commits are squashed to single commit.