Submitting Grantlee as a KF5 Framework

Stephen Kelly steveire at gmail.com
Fri Dec 6 21:36:09 GMT 2019


Hello,

I have been developing Grantlee for over 10 years with contributions 
from a community of others mostly connected with KDE.

  https://github.com/steveire/grantlee

I have not been able to maintain a reasonable release cadence of 
Grantlee in the last few years (last release 3 years ago), so I'm 
submitting Grantlee to KDE Review with the aim of addition to KDE 
Frameworks.

Grantlee consists of two libraries,

* Grantlee::Templates is a text-template system based on Qt introspection
* Grantlee::TextDocument is a builder design pattern implementation for 
processing QTextDocuments

Grantlee is already a dependency of several KDE applications, but it is 
treated as an external dependency. This change would make it a Tier 1 
KDE Framework.

$ apt-cache rdepends libgrantlee-templates5
libgrantlee-templates5
Reverse Depends:
   libgrantlee5-dev
   skrooge
   rocs
   libkf5pimcommon5abi3
   libkf5messageviewer5abi5
   libkf5messageviewer-plugins
   libkf5kaddressbookgrantlee5
   libkf5grantleetheme5
   libkf5grantleetheme-plugins
   libkf5calendarutils5abi1
   libkf5calendarutils-bin
   kdepim-addons
   kjots
   khelpcenter
   kdevelop52-libs
   kdevelop
$ apt-cache rdepends libgrantlee-textdocument5
libgrantlee-textdocument5
Reverse Depends:
   libgrantlee5-dev
   libkf5pimtextedit5abi3
   libkf5messageviewer5abi5
   libkf5messagecomposer5abi2
   kjots


My intention is to make one more release of Grantlee myself before 
turning it into a KDE Frameworks repository.

I don't think much needs to change in terms of the C++ code.  The 
namespace would remain Grantlee:: etc, so that releases made from KDE 
Frameworks will be binary compatible with previous Grantlee5 releases.

However, I've not been putting time into making releases (The last 
release was over 3 years ago).

This is a proposal to submit Grantlee as a KF5 repository. It should be 
a natural addition to the KF5 ecosystem. This move will mean:

* Grantlee will be released regularly as part of KF5
* All KDE contributors will have the commit bit to make changes
* My guilt about lack of releases will be reduced

Grantlee::Templates depends on QtQml for script bindings (can be 
disabled at build time).
Grantlee::TextDocument depends only on QtGui.


I'm not quite familiar with what needs to happen to complete this 
transition. It seems to me that something along these lines ought to do it:

* I make one last release of Grantlee myself
* Set up a new KDE repository for me to push to
* Integrate KF5 buildsystem into Grantlee (ECM for example)
* Set up CI for that repository
* Set up doxygen generation for the repository
* Transfer grantlee.org to KDE sysadmin

Grantlee already has ki18n integration in the form of a library 
implementing Grantlee abstractions:

  https://cgit.kde.org/grantleetheme.git/about/

Initial reviews and comments welcome!

Thanks,

Stephen.




More information about the kde-core-devel mailing list