[ELPA] New package: buildbot.el

[ELPA] New package: buildbot.el

[Yuchen Pei]

[-- Attachment #1: Type: text/plain, Size: 1097 bytes --]

Hello everyone,

I would like to submit buildbot.el (<https://g.ypei.me/buildbot.el.git>)
to the GNU ELPA. It has been how I interact with Buildbot (except for
retrying a build) for a few months now.

From the commentary:

;; `buildbot.el' is an Emacs interface for Buildbot, a widely used
;; continuous integration tool. It can be used to view build
;; information on a Buildbot instance.

;; Main entry points:
;;
;; `buildbot-revision-open' prompts for a revision id (e.g. commit
;; hash in git), and opens a view of the revision, including builds
;; associated with changes associated with the revision.
;;
;; `buildbot-branch-open' prompts for a branch name, and opens up a
;; view of revisions of this branch.
;;
;; `buildbot-builder-open' prompts for a builder name from a list of
;; available builders, and opens up a view of recent builds by this
;; builder.

Full README at https://g.ypei.me/buildbot.el.git/about/, thanks.

Best,
Yuchen

--
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 243 bytes --]

Re: [ELPA] New package: buildbot.el

[Ruijie Yu via Emacs development discussions.]

On Jun 26, 2023, at 15:54, Yuchen Pei <id@ypei.org> wrote:
> 
> Hello everyone,
> 
> I would like to submit buildbot.el (<https://g.ypei.me/buildbot.el.git>)
> to the GNU ELPA. It has been how I interact with Buildbot (except for
> retrying a build) for a few months now.
> 
> From the commentary:
> 
> ;; `buildbot.el' is an Emacs interface for Buildbot, a widely used
> ;; continuous integration tool. It can be used to view build
> ;; information on a Buildbot instance.
> 
> ;; Main entry points:
> ;;
> ;; `buildbot-revision-open' prompts for a revision id (e.g. commit
> ;; hash in git), and opens a view of the revision, including builds
> ;; associated with changes associated with the revision.
> ;;
> ;; `buildbot-branch-open' prompts for a branch name, and opens up a
> ;; view of revisions of this branch.
> ;;
> ;; `buildbot-builder-open' prompts for a builder name from a list of
> ;; available builders, and opens up a view of recent builds by this
> ;; builder.
> 
> Full README at https://g.ypei.me/buildbot.el.git/about/, thanks.

Didn't have that much time to read, but here are some thoughts:

1. Is AGPLv3 acceptable for GNU Elpa?  I thought it is GPL3+ only. 
2. IIUC, once the package is accepted into GNU Elpa, the comments should say that it is "part of Emacs". 
3. Probably a personal preference, but I think you can change normal quotes into function quotes for the last argument to `define-key`.

> Best,
> Yuchen
> 
> --
> PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
>          <https://ypei.org/assets/ypei-pubkey.txt>

Re: [ELPA] New package: buildbot.el

[Yuchen Pei]

Hi,

Thanks for your comments.

On Mon 2023-06-26 21:06:16 +0800, Ruijie Yu wrote:
>
> Didn't have that much time to read, but here are some thoughts:
>
> 1. Is AGPLv3 acceptable for GNU Elpa?

I think so. AGPLv3+ is a copyleft license compatible with GPLv3+.

                                       > I thought it is GPL3+ only.

Citations needed.

> 2. IIUC, once the package is accepted into GNU Elpa, the comments
> should say that it is "part of Emacs".

It should say it is "part of Emacs" only if it is built in emacs core,
no?

> 3. Probably a personal preference, but I think you can change normal
> quotes into function quotes for the last argument to `define-key`.

Good point, done.

Best,
Yuchen

-- 
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>

Re: [ELPA] New package: buildbot.el

[Yuchen Pei]

>>
>> 1. Is AGPLv3 acceptable for GNU Elpa?
>
> I think so. AGPLv3+ is a copyleft license compatible with GPLv3+.

...not to mention the superior protection to user freedom offered
by AGPL over GPL.

Best,
Yuchen

-- 
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>

Re: [ELPA] New package: buildbot.el

[Yuchen Pei]

[-- Attachment #1: Type: text/plain, Size: 514 bytes --]

On Mon 2023-06-26 17:53:03 +1000, Yuchen Pei wrote:

> Hello everyone,
>
> I would like to submit buildbot.el (<https://g.ypei.me/buildbot.el.git>)
> to the GNU ELPA. It has been how I interact with Buildbot (except for
> retrying a build) for a few months now.

Ping, can someone with access to ELPA upload the package please? Or
are there still issues in the way?

Best,
Yuchen

-- 
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 243 bytes --]

Re: [ELPA] New package: buildbot.el

[Yuchen Pei]

[-- Attachment #1: Type: text/plain, Size: 1386 bytes --]

On Tue 2023-07-04 21:24:04 +1000, Yuchen Pei wrote:

> On Mon 2023-06-26 17:53:03 +1000, Yuchen Pei wrote:
>
>> Hello everyone,
>>
>> I would like to submit buildbot.el (<https://g.ypei.me/buildbot.el.git>)
>> to the GNU ELPA. It has been how I interact with Buildbot (except for
>> retrying a build) for a few months now.
>
> Ping, can someone with access to ELPA upload the package please? Or
> are there still issues in the way?

Ping, any updates?

According to the ELPA readme on adding a new package[1]:

--8<---------------cut here---------------start------------->8---
After 48 hours, or once any issues have been addressed, someone will push
your changes for you.  You should probably also subscribe to
[[https://lists.gnu.org/mailman/listinfo/emacs-devel][emacs-devel@gnu.org]], since that's where we discuss about GNU ELPA, and
to [[https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs][bug-gnu-emacs@gnu.org]], since that's where people will report bugs
about your package.
--8<---------------cut here---------------end--------------->8---

It has been almost two weeks. Can someone honour the guidelines and push
my package to ELPA please?

[1] https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/README

Best,
Yuchen

-- 
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 243 bytes --]

Re: [ELPA] New package: buildbot.el

[Protesilaos Stavrou]

> From: Yuchen Pei <id@ypei.org>
> Date: Sun,  9 Jul 2023 13:04:01 +1000

Hello Yuchen,

> On Tue 2023-07-04 21:24:04 +1000, Yuchen Pei wrote:
>
>> On Mon 2023-06-26 17:53:03 +1000, Yuchen Pei wrote:
>>
>>> Hello everyone,
>>>
>>> I would like to submit buildbot.el (<https://g.ypei.me/buildbot.el.git>)
>>> to the GNU ELPA. It has been how I interact with Buildbot (except for
>>> retrying a build) for a few months now.
>>
>> Ping, can someone with access to ELPA upload the package please? Or
>> are there still issues in the way?
>
> Ping, any updates?
>
> According to the ELPA readme on adding a new package[1]:
>
> --8<---------------cut here---------------start------------->8---
> After 48 hours, or once any issues have been addressed, someone will push
> your changes for you.  You should probably also subscribe to
> [[https://lists.gnu.org/mailman/listinfo/emacs-devel][emacs-devel@gnu.org]], since that's where we discuss about GNU ELPA, and
> to [[https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs][bug-gnu-emacs@gnu.org]], since that's where people will report bugs
> about your package.
> --8<---------------cut here---------------end--------------->8---
>
> It has been almost two weeks. Can someone honour the guidelines and push
> my package to ELPA please?
>
> [1] https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/README

I will try to help though note that I have no means of testing buildbot.

Before checking the code of the package:

* You have assigned copyright to the Free Software Foundation and are
  the author/maintainer of the 'hcel' and 'luwak' GNU ELPA packages.

* The 'buildbot' dependency uses the GPL version 2 and is a member of
  the Software Freedom Conservancy.

Notes about the code in your buildbot.el:

1. The 'buildbot.el' file lacks a terminating comment (the "... ends
   here" part).  Your other files have it.

2. I notice that 'M-x checkdoc' returns a few issues in your files.
   Though, for example, in 'buildbot-client.el' they seem to be false
   positives.  Addressing those is not a priority.  I personally do it
   so that notes do not crowd out errors/warnings.

3. In 'buildbot-utils.el' the functions 'buildbot-url-fetch-json' and
   'buildbot-url-fetch-raw' can be consolidated.

4. In 'buildbot-view.el', you are defining key bindings in many
   places.  It may be easier to have them all in one place where the
   keymap is defined as a variable.

All the best,
Protesilaos (or simply "Prot")

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] New package: buildbot.el

[Yuchen Pei]

Hi Prot,

Thanks for your comments. Please find my replies below.
On Tue 2023-07-11 00:06:12 +0300, Protesilaos Stavrou wrote:
>
> I will try to help though note that I have no means of testing
> buildbot.

Below I expand the example from README.org, using the mariadb buildbot.

First, some setup

#+begin_src elisp
(require 'buildbot)
(setq buildbot-host "https://buildbot.mariadb.org")
(setq buildbot-builders (buildbot-get-all-builders))
#+end_src

Then, run one of the three entry point commands
`buildbot-revision-open', `buildbot-branch-open', or
`buildbot-builder-open' to get build results.

For example, to see build results of the 11.1 branch, do

M-x buildbot-branch-open <RET> 11.1 <RET>

which will display the commits and their build results.

HOWEVER, I made a mistake in assuming the package would work with any
buildbot instance with version >= 0.9.0: trying a few instances on [1]
I found out that is not the case. So I will need to fix that.

[1] https://github.com/buildbot/buildbot/wiki/SuccessStories

>
> Before checking the code of the package:
>
> * You have assigned copyright to the Free Software Foundation and are
>   the author/maintainer of the 'hcel' and 'luwak' GNU ELPA packages.
>
> * The 'buildbot' dependency uses the GPL version 2 and is a member of
>   the Software Freedom Conservancy.

Yeah, though this kind of dependency is different from the dependency on
another library e.g. the dependency on the `json' feature. From a
license point of view, the license of a client program gnerally should
not affect or be affected by that of a server program on another
computer.

From a user freedom point of view, it is not an issue if 1. the server
program does not do the user's own computing OR 2. the server is
controlled by a project the user belongs to and the server program is
free. So because of 1. it is ok to download / stream video from youtube
if it does not involve nonfree js because the video is hosted on another
computer. In the case of buildbot or CI in general it is a bit more
complicated because CI is doing the user's own computing, i.e. compiling
and testing code, but I think it is safe to assume the typical user of a
CI is a developer of a project they are part of i.e. 2. is satisfied.

https://www.gnu.org/philosophy/who-does-that-server-really-serve.en.html

>
> Notes about the code in your buildbot.el:
>
> 1. The 'buildbot.el' file lacks a terminating comment (the "... ends
>    here" part).  Your other files have it.

Done.

>
> 2. I notice that 'M-x checkdoc' returns a few issues in your files.
>    Though, for example, in 'buildbot-client.el' they seem to be false
>    positives.  Addressing those is not a priority.  I personally do it
>    so that notes do not crowd out errors/warnings.

They are all "Probably "foos" should be imperative "foo"", which do
not make sense to me. An example is the docstring "Get the
revision-info and builds from a set of CHANGES." where it complains
about the "CHANGES".

>
> 3. In 'buildbot-utils.el' the functions 'buildbot-url-fetch-json' and
>    'buildbot-url-fetch-raw' can be consolidated.

Done.

>
> 4. In 'buildbot-view.el', you are defining key bindings in many
>    places.  It may be easier to have them all in one place where the
>    keymap is defined as a variable.
>

Done.

Best,
Yuchen

-- 
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>

Re: [ELPA] New package: buildbot.el

[Protesilaos Stavrou]

> From: Yuchen Pei <id@ypei.org>
> Date: Wed, 12 Jul 2023 00:58:47 +1000
>
> Hi Prot,

Good day Yuchen,

> Thanks for your comments. Please find my replies below.
>
> [... 93 lines elided]

Thank you for taking the time to do this!

I just added buildbot to GNU ELPA on your behalf.  You will receive a
notification when the package is built.

All the best,
Prot

-- 
Protesilaos Stavrou
https://protesilaos.com

Re: [ELPA] New package: buildbot.el

[Yuchen Pei]

Hello Prot,
On Thu 2023-07-13 07:53:22 +0300, Protesilaos Stavrou wrote:

>> From: Yuchen Pei <id@ypei.org>
>> Date: Wed, 12 Jul 2023 00:58:47 +1000
>>
>> Hi Prot,
>
> Good day Yuchen,
>
>> Thanks for your comments. Please find my replies below.
>>
>> [... 93 lines elided]
>
> Thank you for taking the time to do this!
>
> I just added buildbot to GNU ELPA on your behalf.  You will receive a
> notification when the package is built.

Thanks a lot for your help. I notice some trivial looking errors causing
build failures. I will try to fix it today.

I will fix the less trivial issue about supporting more instances
mentioned in my previous email later this week.

Best,
Yuchen

-- 
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>

Re: [ELPA] New package: buildbot.el

[Yuchen Pei]

On Thu 2023-07-13 22:01:38 +1000, Yuchen Pei wrote:

>
> Thanks a lot for your help. I notice some trivial looking errors causing
> build failures. I will try to fix it today.
>

I tested the build locally and pushed
70f484764c58ee2e1a2eb0b494d07f52cbd01938 which should fix the complaint
about missing (actually not missing, but incorrect) copyright header.

The other issue (search-failed ";;; buildbot.el ends here"), is caused
by the building script looking for the first commit with the current
version (IIUC) and building from there. That commit did not have the
required ending string. Resetting the version to 0 now, and in the
future, re-resetting it to a nonzero version when the package is ready
for release, should stop this failure. So I pushed
6f5130ec952f6213f9ce93e425aa1cfc9256ee90 for that.

Best,
Yuchen

-- 
PGP Key: 47F9 D050 1E11 8879 9040  4941 2126 7E93 EF86 DFD0
          <https://ypei.org/assets/ypei-pubkey.txt>