Hi there, I'm writing to request that my PKGBUILD for *kate-wakatime* be added to the Arch User Repository (AUR). I have tested the PKGBUILD and it works as expected. But I'm unsure about this script's formatting or other checkups. I'll really appreciate any advice. Here's my PKGBUILD,
# Maintainer: sharafat <sharafat two thousand four at gmail>
pkgname=kate-wakatime-git pkgver=1.3.10 pkgrel=1 pkgdesc=" Kate plugin to interface with WakaTime" arch=('x86_64') url="https://github.com/wakatime/$pkgname" license=('unknown') makedepends=('git' 'cmake' 'extra-cmake-modules') depends=('kate') conflicts=('kate-wakatime') source=("git+https://github.com/Tatsh/kate-wakatime") md5sums=('SKIP')
build() { cmake -B build -S "kate-wakatime" \ -DCMAKE_BUILD_TYPE='None' \ -DCMAKE_INSTALL_PREFIX='/usr' \ -Wno-dev cmake --build build }
check() { ctest --test-dir build --output-on-failure }
package() { DESTDIR="$pkgdir" cmake --install build }
Thank you for considering my request.
Hello, It is not the responsibility of the TU's to add your AUR packages. Create a git repository and push it to the AUR, if you would like someone to check/test your PKGBUILD people will happily do that for you. Please read https://wiki.archlinux.org/title/AUR_submission_guidelines for more information :) Good luck, Polarian
pkgname=kate-wakatime-git pkgver=1.3.10
So is this a VCS package [1] or not?
pkgdesc=" Kate plugin to interface with WakaTime"
Redundant space at the beginning.
arch=('x86_64')
Does this build on other architectures?
The URL here uses $pkgname, which has the -git suffix, so it's not a valid URL. Another thing is that although this is maintained by WakaTime organisation in GitHub, it's behind [2] that it was forked from. Is there any reason to not used [2] instead?
license=('unknown')
From their source code: 'you can redistribute it and/or modify it under the terms of the GNU Library General Public License version 3, or (at your option) any later version'.
-DCMAKE_BUILD_TYPE='None' \
Shouldn't this be Release or RelWithDebInfo? [3] PS: You don't have to send emails in both plaintext and HTML here. [1] https://wiki.archlinux.org/title/VCS_package_guidelines [2] https://github.com/Tatsh/kate-wakatime [3] https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html On 9/1/23 23:14, Sharafat Karim wrote:
Hi there,
I'm writing to request that my PKGBUILD for /kate-wakatime/ be added to the Arch User Repository (AUR). I have tested the PKGBUILD and it works as expected. But I'm unsure about this script's formatting or other checkups. I'll really appreciate any advice.
Here's my PKGBUILD,
# Maintainer: sharafat <sharafat two thousand four at gmail>
pkgname=kate-wakatime-git pkgver=1.3.10 pkgrel=1 pkgdesc=" Kate plugin to interface with WakaTime" arch=('x86_64') url="https://github.com/wakatime/$pkgname <https://github.com/wakatime/$pkgname>" license=('unknown') makedepends=('git' 'cmake' 'extra-cmake-modules') depends=('kate') conflicts=('kate-wakatime') source=("git+https://github.com/Tatsh/kate-wakatime <https://github.com/Tatsh/kate-wakatime>") md5sums=('SKIP')
build() { cmake -B build -S "kate-wakatime" \ -DCMAKE_BUILD_TYPE='None' \ -DCMAKE_INSTALL_PREFIX='/usr' \ -Wno-dev cmake --build build }
check() { ctest --test-dir build --output-on-failure }
package() { DESTDIR="$pkgdir" cmake --install build }
Thank you for considering my request.
-- Frederick Zhang PGP: 8BFB EA5B 4C44 BFAC C8EC 5F93 1F92 8BE6 0D8B C11D
And I just realised:
url="https://github.com/wakatime/$pkgname" source=("git+https://github.com/Tatsh/kate-wakatime")
I think it's better to use the same repository for URL and source.
conflicts=('kate-wakatime')
Is there already a package named kate-wakatime somewhere? I searched both official repository and AUR but failed to find one. On 9/1/23 23:33, Frederick Zhang wrote:
pkgname=kate-wakatime-git pkgver=1.3.10
So is this a VCS package [1] or not?
pkgdesc=" Kate plugin to interface with WakaTime"
Redundant space at the beginning.
arch=('x86_64')
Does this build on other architectures?
The URL here uses $pkgname, which has the -git suffix, so it's not a valid URL.
Another thing is that although this is maintained by WakaTime organisation in GitHub, it's behind [2] that it was forked from. Is there any reason to not used [2] instead?
license=('unknown')
From their source code: 'you can redistribute it and/or modify it under the terms of the GNU Library General Public License version 3, or (at your option) any later version'.
-DCMAKE_BUILD_TYPE='None' \
Shouldn't this be Release or RelWithDebInfo? [3]
PS: You don't have to send emails in both plaintext and HTML here.
[1] https://wiki.archlinux.org/title/VCS_package_guidelines [2] https://github.com/Tatsh/kate-wakatime [3] https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html
On 9/1/23 23:14, Sharafat Karim wrote:
Hi there,
I'm writing to request that my PKGBUILD for /kate-wakatime/ be added to the Arch User Repository (AUR). I have tested the PKGBUILD and it works as expected. But I'm unsure about this script's formatting or other checkups. I'll really appreciate any advice.
Here's my PKGBUILD,
# Maintainer: sharafat <sharafat two thousand four at gmail>
pkgname=kate-wakatime-git pkgver=1.3.10 pkgrel=1 pkgdesc=" Kate plugin to interface with WakaTime" arch=('x86_64') url="https://github.com/wakatime/$pkgname <https://github.com/wakatime/$pkgname>" license=('unknown') makedepends=('git' 'cmake' 'extra-cmake-modules') depends=('kate') conflicts=('kate-wakatime') source=("git+https://github.com/Tatsh/kate-wakatime <https://github.com/Tatsh/kate-wakatime>") md5sums=('SKIP')
build() { cmake -B build -S "kate-wakatime" \ -DCMAKE_BUILD_TYPE='None' \ -DCMAKE_INSTALL_PREFIX='/usr' \ -Wno-dev cmake --build build }
check() { ctest --test-dir build --output-on-failure }
package() { DESTDIR="$pkgdir" cmake --install build }
Thank you for considering my request.
-- Frederick Zhang PGP: 8BFB EA5B 4C44 BFAC C8EC 5F93 1F92 8BE6 0D8B C11D
And I just realised:
url="https://github.com/wakatime/$pkgname" source=("git+https://github.com/Tatsh/kate-wakatime")
I think it's better to use the same repository for URL and source. Not necessarily. If the package has an official website, it should be used in the URL var instead of the repo. So in this case, the URL should contain the official website URL of the
Le 09/01/2023 à 13:48, Frederick Zhang a écrit : package [1] and the source array should contain the GitHub repo [2].
conflicts=('kate-wakatime')
Is there already a package named kate-wakatime somewhere? I searched both official repository and AUR but failed to find one.
Even though there's no package named "kate-wakatime" (yet), I think the "kate-wakatime-git" package could (should?) still conflicts with it, in case there's one someday. [1] https://tatsh.github.io/kate-wakatime [2] https://github.com/Tatsh/kate-wakatime -- Regards, Antiz (Robin C.)
Hello, The url is meant solely for the project URL, such as information on the project etc, some projects use different URLS for downloads, such as CI/CD etc, and thus the source and the URL DO NOT need to be the same! as for the conflicts option, it does not hurt conflicting a package which you know will conflict your package if created, but this is personal opinion Good luck -- Polarian GPG signature: 0770E5312238C760 Website: https://polarian.dev JID/XMPP: polarian@polarian.dev
On 9/1/23 23:57, Robin Candau wrote:
Not necessarily. If the package has an official website, it should be used in the URL var instead of the repo. So in this case, the URL should contain the official website URL of the package [1] and the source array should contain the GitHub repo [2].
On 10/1/23 00:00, Polarian wrote:
The url is meant solely for the project URL, such as information on the project etc, some projects use different URLS for downloads, such as CI/CD etc, and thus the source and the URL DO NOT need to be the same!
Allow me to rephrase :) I meant these two URIs should be related to the same fork i.e. Git remote. If Sharafat in the end decides to use Tatsh/kate-wakatime, then surely [1] will be the best option (good job finding it btw); but if wakatime/kate-wakatime is used for source in the end, I don't think [1] would still be appropriate as url? Let me know if this isn't true of course. On 9/1/23 23:57, Robin Candau wrote:
Even though there's no package named "kate-wakatime" (yet), I think the "kate-wakatime-git" package could (should?) still conflicts with it, in case there's one someday.
On 10/1/23 00:00, Polarian wrote:
as for the conflicts option, it does not hurt conflicting a package which you know will conflict your package if created, but this is personal opinion
TIL! Thank you. [1] https://tatsh.github.io/kate-wakatime On 9/1/23 23:57, Robin Candau wrote:
And I just realised:
url="https://github.com/wakatime/$pkgname" source=("git+https://github.com/Tatsh/kate-wakatime")
I think it's better to use the same repository for URL and source. Not necessarily. If the package has an official website, it should be used in the URL var instead of the repo. So in this case, the URL should contain the official website URL of the
Le 09/01/2023 à 13:48, Frederick Zhang a écrit : package [1] and the source array should contain the GitHub repo [2].
conflicts=('kate-wakatime')
Is there already a package named kate-wakatime somewhere? I searched both official repository and AUR but failed to find one.
Even though there's no package named "kate-wakatime" (yet), I think the "kate-wakatime-git" package could (should?) still conflicts with it, in case there's one someday.
[1] https://tatsh.github.io/kate-wakatime [2] https://github.com/Tatsh/kate-wakatime
-- Regards, Antiz (Robin C.)
On 10/1/23 00:00, Polarian wrote:
Hello,
The url is meant solely for the project URL, such as information on the project etc, some projects use different URLS for downloads, such as CI/CD etc, and thus the source and the URL DO NOT need to be the same!
as for the conflicts option, it does not hurt conflicting a package which you know will conflict your package if created, but this is personal opinion
-- Frederick Zhang PGP: 8BFB EA5B 4C44 BFAC C8EC 5F93 1F92 8BE6 0D8B C11D
On Mon, Jan 9, 2023 at 4:34 PM Frederick Zhang <frederick888@tsundere.moe> wrote:
-DCMAKE_BUILD_TYPE='None' \
Shouldn't this be Release or RelWithDebInfo? [3]
PS: You don't have to send emails in both plaintext and HTML here.
[1] https://wiki.archlinux.org/title/VCS_package_guidelines [2] https://github.com/Tatsh/kate-wakatime [3] https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html
Arch Wiki recommends CMAKE_BUILD_TYPE=None https://wiki.archlinux.org/title/CMake_package_guidelines#CMake_undesired_be...
Le 09/01/2023 à 13:14, Sharafat Karim a écrit :
Hi there,
Hi!
I'm writing to request that my PKGBUILD for kate-wakatime be added to the Arch User Repository (AUR). I have tested the PKGBUILD and it works as expected. But I'm unsure about this script's formatting or other checkups. I'll really appreciate any advice.
The AUR is community maintained. There's no request to make, it's up to you to upload it or not [1] ;)
Here's my PKGBUILD,
# Maintainer: sharafat <sharafat two thousand four at gmail>
pkgname=kate-wakatime-git pkgver=1.3.10 pkgrel=1 pkgdesc=" Kate plugin to interface with WakaTime" arch=('x86_64') url="https://github.com/wakatime/$pkgname" license=('unknown') makedepends=('git' 'cmake' 'extra-cmake-modules') depends=('kate') conflicts=('kate-wakatime') source=("git+https://github.com/Tatsh/kate-wakatime") md5sums=('SKIP')
build() { cmake -B build -S "kate-wakatime" \ -DCMAKE_BUILD_TYPE='None' \ -DCMAKE_INSTALL_PREFIX='/usr' \ -Wno-dev cmake --build build }
check() { ctest --test-dir build --output-on-failure }
package() { DESTDIR="$pkgdir" cmake --install build }
There's a few problems in that PKGBUILD: - The pkgname and the source array implies that this package is a GIT/VCS package. According to that, the PKGBUILD has to contain a dedicated "pkgver ()" function [2]. - The url variable is wrong --> https://github.com/wakatime/kate-wakatime-git is not a valid URL. You should use the one provided in the description of the package on the GitHub repo [3] - The license used by the project seems to be GLP3 according to the source code [4]. Maybe they should make this more clear by specifying the license on the GitHub repo though. [1] https://wiki.archlinux.org/title/AUR_submission_guidelines [2] https://wiki.archlinux.org/title/VCS_package_guidelines#The_pkgver()_functio... [3] https://tatsh.github.io/kate-wakatime/ [4] https://github.com/Tatsh/kate-wakatime/search?q=GNU -- Regards, Antiz (Robin C.)
participants (5)
-
eNV25
-
Frederick Zhang
-
Polarian
-
Robin Candau
-
Sharafat Karim