* bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs?
@ 2024-10-14 20:54 Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-10-14 21:29 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-10-14 20:54 UTC (permalink / raw)
To: 73808; +Cc: philipk
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
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs?
2024-10-14 20:54 bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs? Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-10-14 21:29 ` Stefan Kangas
2024-10-14 21:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2024-10-14 21:29 UTC (permalink / raw)
To: Lin Jian, 73808; +Cc: philipk, Andrew Hyatt, Stefan Monnier
Lin Jian via "Bug reports for GNU Emacs, the Swiss army knife of text
editors" <bug-gnu-emacs@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
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs?
2024-10-14 21:29 ` Stefan Kangas
@ 2024-10-14 21:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-10-14 22:11 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-10-14 21:37 UTC (permalink / raw)
To: Stefan Kangas; +Cc: Andrew Hyatt, philipk, 73808, Stefan Monnier
Stefan Kangas <stefankangas@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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs?
2024-10-14 21:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-10-14 22:11 ` Stefan Kangas
2024-10-14 22:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2024-10-14 22:11 UTC (permalink / raw)
To: Lin Jian; +Cc: Andrew Hyatt, philipk, 73808, Stefan Monnier
Lin Jian <me@linj.tech> writes:
> Stefan Kangas <stefankangas@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.)
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs?
2024-10-14 22:11 ` Stefan Kangas
@ 2024-10-14 22:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-10-14 23:03 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-10-14 22:37 UTC (permalink / raw)
To: Stefan Kangas; +Cc: Andrew Hyatt, philipk, 73808, Stefan Monnier
Stefan Kangas <stefankangas@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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs?
2024-10-14 22:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-10-14 23:03 ` Stefan Kangas
0 siblings, 0 replies; 6+ messages in thread
From: Stefan Kangas @ 2024-10-14 23:03 UTC (permalink / raw)
To: Lin Jian; +Cc: philipk, Andrew Hyatt, Stefan Monnier, 73808-done
Lin Jian <me@linj.tech> writes:
> Stefan Kangas <stefankangas@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.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2024-10-14 23:03 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-10-14 20:54 bug#73808: 30.0.91; Should test files be included in GNU ELPA tarballs? Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-10-14 21:29 ` Stefan Kangas
2024-10-14 21:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-10-14 22:11 ` Stefan Kangas
2024-10-14 22:37 ` Lin Jian via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-10-14 23:03 ` Stefan Kangas
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).