Skip to content

Conversation

pabl0
Copy link
Contributor

@pabl0 pabl0 commented Mar 12, 2025

Just some minor finishing touch before 0.9.8 release to elpa.nongu.org.

MELPA does not include documentation (README.org, NEWS, LICENSE) by default, unlike (non-)GNUELPA. But IMHO they are useful (and not litter, like .github/ISSUE_TEMPLATE) and consume tiny amount of disk space, so I don't see a reason to exclude them.

Ignore .github (and .elpaignore itself) from ELPA releases.
@karthink
Copy link
Owner

  • I'm confused by what placing .elpaignore in .elpaignore does.
  • I didn't understand how this PR relates to what MELPA includes or doesn't include.

@pabl0
Copy link
Contributor Author

pabl0 commented Mar 13, 2025

  • I'm confused by what placing .elpaignore in .elpaignore does.

ELPA does not exclude the .elpaignore file itself from the package tarballs. Many projects (but definedly not all) seem to include it in .elpaignore. I just verified that installing v0.9.7 from elpa.nongnu.org does indeed leave the file under .emacs.d/elpa/gptel-0.9.7, so it is not striped during installation.

I'm not sure whether the ELPA team sees this as an issue or an intended part of the design. Should we discuss it on emacs-devel?

* I didn't understand how this PR relates to what MELPA includes or doesn't include.

It does not directly. But since ELPA and MELPA have the opposite logic, right now gptel installed from ELPA includes documentation files, while MELPA only contain .el files.

If we aim for identicality, we'd either have to drop the documentation with in .elpaignore or adjust the MELPA recipe to include them. However, MELPA advises against including additional files, a "cultural difference" we likely want to observe. In ELPA, it's common to include, however LICENSE and COPYING (etc) are mostly listed as :ignored-files.

(I am probably just dumb, but I don't know where to find the elpa-packages file for nongnu, is it on a separate git repo or some branch?)

@karthink
Copy link
Owner

karthink commented Mar 13, 2025 via email

@pabl0
Copy link
Contributor Author

pabl0 commented Mar 13, 2025

(I am probably just dumb, but I don't know where to find the elpa-packages file for nongnu, is it on a separate git repo or some branch?)

To be honest, I never even imagined I could be anything but dumb. The repo is of course in git.savannah and here is the relevant part for gptel in elpa-packages (in the branch called main):

 (gptel                 :url "https://github.com/karthink/gptel"
  :readme ignore)

I agree that ignoring the README file is a good idea, since the commentary section in gptel.el is more consise for this purpose. Of course the two are somewhat redundant.

@pabl0
Copy link
Contributor Author

pabl0 commented Mar 13, 2025

I agree that ignoring the README file is a good idea, since the commentary section in gptel.el is more consise for this purpose. Of course the two are somewhat redundant.

And to clarify, :readme ignore means the elpa.nongnu.org web site or the describe-package functions shows the commentary section from gtpel.el, but it still shipped under the .emacs.d/elpa directory for the user's local viewing pleasure.

@pabl0
Copy link
Contributor Author

pabl0 commented Mar 13, 2025

Maybe we can seek some quick verification from Philip Kaludercic that this is okay to add .elpaignore to .elpaignore? Unless you are sure that it's okay, then I'll take your word for it.

Well at least it should be safe and not break anything, since e.g. transient is doing it:

https://github.com/magit/transient/blob/main/.elpaignore

It seems that including .gitignore is unecessary, it get's excluded by default.

@karthink
Copy link
Owner

Well at least it should be safe and not break anything, since e.g. transient is doing it:

Works for me!

@karthink karthink merged commit 9245dfd into karthink:master Mar 13, 2025
psionic-k added a commit to positron-solutions/gptel that referenced this pull request Mar 15, 2025
See upstream for individual commits.

748fd85 gptel: Remove nosystem capability for o1/o3 models (karthink#702)
7de8e88 gptel-curl: Add gptel-curl-extra-args
4c5f7e6 gptel: Bump version to v0.9.8
2835d93 gptel: Remove obsolete variables, update NEWS
cc3d74d gptel-org: Obey gptel-org settings when sending regions
8a289e9 gptel-transient: Return to menu with just RET (karthink#695)
9245dfd elpaignore: Add .github (karthink#699)
10e7739 gptel-transient: Don't serialize backend to transient history
e77a47b NEWS: Use org comment and fill paragraphs (karthink#696)
d9edbbc NEWS: Add news file
85a3c00 test: Update submodule
6320c2b gptel: Use font-lock-flush instead of font-lock-fontify-region
7400df6 gptel: Create all prompts in temp buffer
aef57c2 gptel-openai-extras: Fix Deepseek repeated roles error
8889e27 gptel-rewrite: Ignore reasoning output correctly
4edf81c gptel: Linting
354829b test: Update for gptel-org-ignore-elements
b7eb4fc gptel-org: Strip property drawers from the prompt
4ca50d7 gptel-anthropic: Fix reasoning parsing bug
d9ce451 gptel-anthropic: Add prompt caching (karthink#355)
c23cba5 gptel: Add blocks around reasoning content
6de3e00 gptel: Change how reasoning content is tracked
44f75b7 gptel-transient: Fix key collision in gptel-menu
95eefe4 gptel-org: Fix typo from refactoring
8e0d682 gptel-openai: Fix collision with openrouter parsing (karthink#669)
0a2fcb9 gptel-curl: Handle end of reasoning stream in other buffer
3963aff gptel-org: Use gptel-org- prefix consistently
marcbowes pushed a commit to marcbowes/gptel that referenced this pull request Mar 19, 2025
.elpaignore: Ignore .github (and .elpaignore itself) from 
ELPA releases.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants