search

quicklisp / quicklisp-projects

Metadata for projects tracked by Quicklisp.
http://www.quicklisp.org/
415 stars 47 forks source link

Add description of supported source formats #2258

Closed Zulu-Inuoe closed 1 year ago

Zulu-Inuoe commented 1 year ago

I'm aware there are no PR's to add/modify projects, but I wanted to provide an updated README as I was unaware of the various available ways to specify a new project for Quicklisp, and wished to document this.

Even if the PR is blocked, please consider updating the documentation.

Thanks!

quicklisp commented 1 year ago

Thanks for this work. In general, I am not against documenting that I can form project releases in a number of different ways. This specific change, I think, is not good, because it documents it at too-low a level of detail (I don't want people to work directly with the source descriptions) and it documents methods that I wish to deprecate (like single-file sources) or which are inapplicable (like kmr or ediware sources).

On Wed, Feb 15, 2023 at 4:08 PM Wilfredo Velázquez-Rodríguez < @.***> wrote:

I'm aware there are no PR's to add/modify projects, but I wanted to provide an updated README as I was unaware of the various available ways to specify a new project for Quicklisp, and wished to document this.

Even if the PR is blocked, please consider updating the documentation.

Thanks!

You can view, comment on, or merge this pull request online at:

https://github.com/quicklisp/quicklisp-projects/pull/2258 Commit Summary

File Changes

(1 file https://github.com/quicklisp/quicklisp-projects/pull/2258/files)

Patch Links:

— Reply to this email directly, view it on GitHub https://github.com/quicklisp/quicklisp-projects/pull/2258, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACPNLMKVJN6E3WTRH423ADWXVAVVANCNFSM6AAAAAAU5K6WKY . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Zulu-Inuoe commented 1 year ago

Understood, is there a way that people could communicate how they wish to pull sources? If so, I think it makes sense to list out the ways that you consider canonical (meaning, not listing stuff like ediware).

It could be something along the lines of

Quicklisp can source projects from

  • Darcs, Git, or Mercurial Repo URL
  • GitHub Releases or Tags
  • GitLab Releases

When entering a new project, please provide a way to pull this project's sources.

plus/minus however many you want to add.

FYI My motivation is that after putting #2256 in, I asked around for a way to link back the QL release to a commit hash and was told "You should have used a GitHub release", but I had no idea that was even an option. So I'd like to avoid that in the future

quicklisp commented 1 year ago

I'll try to add something like that.

If you had asked around on the issue, I could also have helped.

On Thu, Feb 16, 2023 at 8:26 AM Wilfredo Velázquez-Rodríguez < @.***> wrote:

Understood, is there a way that people could communicate how they wish to pull sources? If so, I think it makes sense to list out the ways that you consider canonical (meaning, not listing stuff like ediware).

It could be something along the lines of

Quicklisp can source projects from

  • Darcs, Git, or Mercurial Repo URL
  • GitHub Releases or Tags
  • GitLab Releases

When entering a new project, please provide a way to pull this project's sources.

plus/minus however many you want to add.

FYI My motivation is that after putting #2256 https://github.com/quicklisp/quicklisp-projects/issues/2256 in, I asked around for a way to link back the QL release to a commit hash and was told "You should have used a GitHub release", but I had no idea that was even an option. So I'd like to avoid that in the future

— Reply to this email directly, view it on GitHub https://github.com/quicklisp/quicklisp-projects/pull/2258#issuecomment-1433086685, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACPNLN3ZXU4QEKJUWU5WPDWXYTHNANCNFSM6AAAAAAU5K6WKY . You are receiving this because you commented.Message ID: @.***>

Zulu-Inuoe commented 1 year ago

Alright great, thank you!