GNU bug report logs - #73808
30.0.91; Should test files be included in GNU ELPA tarballs?

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 73808 in the body.
You can then email your comments to 73808 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Lin Jian <me <at> linj.tech>
To: bug-gnu-emacs <at> gnu.org
Cc: philipk <at> posteo.net
Subject: 30.0.91; Should test files be included in GNU ELPA tarballs?
Date: Tue, 15 Oct 2024 04:54:29 +0800

Some GNU ELPA packages include test files in their tarballs, such as
triples[1].  Test files may have extra dependencies.  For example,
triples-test.el[2] requires kv.  When installing package tarballs, those
extra dependencies cause compilation errors, which causes package build
failures in our NixOS CI.

Given that users probably do not need those test files, I think it is a
good idea to exclude them from tarballs.  MELPA does that by default[3].

WDYT?

[1]: https://elpa.gnu.org/packages/triples.html
[2]: https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/triples-test.el?h=externals/triples&id=cf7f9c8dd77e47a1c32e0d0026df86a0eac4e2a5#n30
[3]: https://github.com/melpa/melpa?tab=readme-ov-file#recipe-format

Message #8 received at 73808 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Lin Jian <me <at> linj.tech>, 73808 <at> debbugs.gnu.org
Cc: philipk <at> posteo.net, Andrew Hyatt <ahyatt <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#73808: 30.0.91;
 Should test files be included in GNU ELPA tarballs?
Date: Mon, 14 Oct 2024 21:29:59 +0000

Lin Jian via "Bug reports for GNU Emacs, the Swiss army knife of text
editors" <bug-gnu-emacs <at> gnu.org> writes:

> Some GNU ELPA packages include test files in their tarballs, such as
> triples[1].  Test files may have extra dependencies.  For example,
> triples-test.el[2] requires kv.  When installing package tarballs, those
> extra dependencies cause compilation errors, which causes package build
> failures in our NixOS CI.
>
> Given that users probably do not need those test files, I think it is a
> good idea to exclude them from tarballs.  MELPA does that by default[3].
>
> WDYT?

The best way to exclude the test files is to add a .elpaignore file to
the upstream project.  We can also do that on our end, but that makes it
less flexible for the package maintainer.

>
> [1]: https://elpa.gnu.org/packages/triples.html
> [2]: https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/triples-test.el?h=externals/triples&id=cf7f9c8dd77e47a1c32e0d0026df86a0eac4e2a5#n30
> [3]: https://github.com/melpa/melpa?tab=readme-ov-file#recipe-format

Message #11 received at 73808 <at> debbugs.gnu.org (full text, mbox):

From: Lin Jian <me <at> linj.tech>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: Andrew Hyatt <ahyatt <at> gmail.com>, philipk <at> posteo.net, 73808 <at> debbugs.gnu.org,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#73808: 30.0.91; Should test files be included in GNU ELPA
 tarballs?
Date: Tue, 15 Oct 2024 05:37:59 +0800

Stefan Kangas <stefankangas <at> gmail.com> writes:

> The best way to exclude the test files is to add a .elpaignore file to
> the upstream project.

Agreed.  What about adding some documentation about this?

> We can also do that on our end, but that makes it
> less flexible for the package maintainer.

Message #14 received at 73808 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Lin Jian <me <at> linj.tech>
Cc: Andrew Hyatt <ahyatt <at> gmail.com>, philipk <at> posteo.net, 73808 <at> debbugs.gnu.org,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#73808: 30.0.91;
 Should test files be included in GNU ELPA tarballs?
Date: Mon, 14 Oct 2024 15:11:57 -0700

Lin Jian <me <at> linj.tech> writes:

> Stefan Kangas <stefankangas <at> gmail.com> writes:
>
>> The best way to exclude the test files is to add a .elpaignore file to
>> the upstream project.
>
> Agreed.  What about adding some documentation about this?

The below text has been added in Emacs 30 to
(info "(elisp) Multi-file Packages")

       If your package contains files that you don't wish to distribute
    to users (e.g. regression tests), you can add them to an
    ‘.elpaignore’ file.  In this file, each line lists a file or a
    wildcard matching files; those files should be ignored when
    producing your package's tarball on ELPA (*note Package Archives::).
    (ELPA will pass this file to the ‘tar’ command via the ‘-X’
    command-line option, when it prepares the package for download.)

Message #17 received at 73808 <at> debbugs.gnu.org (full text, mbox):

From: Lin Jian <me <at> linj.tech>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: Andrew Hyatt <ahyatt <at> gmail.com>, philipk <at> posteo.net, 73808 <at> debbugs.gnu.org,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#73808: 30.0.91; Should test files be included in GNU ELPA
 tarballs?
Date: Tue, 15 Oct 2024 06:37:08 +0800

Stefan Kangas <stefankangas <at> gmail.com> writes:


> The below text has been added in Emacs 30 to
> (info "(elisp) Multi-file Packages")

That's great.  Thanks for the info.

Feel free to close this ELPA bug.

Message #22 received at 73808-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Lin Jian <me <at> linj.tech>
Cc: philipk <at> posteo.net, Andrew Hyatt <ahyatt <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>, 73808-done <at> debbugs.gnu.org
Subject: Re: bug#73808: 30.0.91;
 Should test files be included in GNU ELPA tarballs?
Date: Mon, 14 Oct 2024 23:03:30 +0000

Lin Jian <me <at> linj.tech> writes:

> Stefan Kangas <stefankangas <at> gmail.com> writes:
>
>
>> The below text has been added in Emacs 30 to
>> (info "(elisp) Multi-file Packages")
>
> That's great.  Thanks for the info.
>
> Feel free to close this ELPA bug.

Thanks, I'm closing the bug with this message.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.