Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Manifest description #124

Closed
jamesdbrock opened this issue Jan 31, 2021 · 1 comment · Fixed by #282
Closed

Manifest description #124

jamesdbrock opened this issue Jan 31, 2021 · 1 comment · Fixed by #282
Labels
good first issue Good for newcomers help wanted Extra attention is needed schema
Milestone
alpha-1

Comments

@jamesdbrock
Copy link
Contributor

It would be nice if Metadata had a description field for use by Pursuit, see purescript/pursuit#431

https://github.com/purescript/registry/blob/bfa073019247439c000feb304555675711948514/v1/Metadata.dhall#L18-L25
@f-f
Copy link
Member

f-f commented Feb 1, 2021

Hey @jamesdbrock! It would be indeed good to have a description field, but I think we should have it in the Manifest, rather than the Metadata. Here:

https://github.com/purescript/registry/blob/bfa073019247439c000feb304555675711948514/v1/Manifest.dhall#L13-L24

The difference being that the Manifest is totally in the hands of the package authors as it's versioned together with the package sources, while the Metadata resides in this repo, it's meant to be 100% handled by our CI automation (as it contains information for CI itself), and contains sensitive information (the hashes of the package tarballs), so pull requests to it will likely be forbidden.

@f-f f-f added enhancement Something that would be good to have but it's not a priority good first issue Good for newcomers help wanted Extra attention is needed labels Feb 1, 2021
@f-f f-f mentioned this issue Mar 30, 2021
Merged
@f-f f-f added this to the v0.1 milestone Apr 26, 2021
@thomashoneyman thomashoneyman mentioned this issue May 22, 2021
Closed
@f-f f-f changed the title Metadata description Manifest description Nov 24, 2021
@f-f f-f added schema and removed enhancement Something that would be good to have but it's not a priority labels Dec 1, 2021
@f-f f-f mentioned this issue Dec 26, 2021
Merged
@f-f f-f linked a pull request Dec 26, 2021 that will close this issue
Add description #282
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed schema
Projects
None yet
Milestone
alpha-1
Development

Successfully merging a pull request may close this issue.

Add description purescript/registry-dev
2 participants
@jamesdbrock @f-f