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.

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

Add License field to PackageInfo.g format #997

Closed
6 tasks done
fingolfin opened this issue Dec 7, 2016 · 8 comments
Closed
6 tasks done

Add License field to PackageInfo.g format #997

fingolfin opened this issue Dec 7, 2016 · 8 comments
Assignees
Labels
kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes topic: packages issues or PRs related to package handling, or specific to a package (for packages w/o issue tracker)
Milestone

Comments

@fingolfin
Copy link
Member

fingolfin commented Dec 7, 2016

(I thought I'd seen this discussed before, but didn't see an issue, so I am opening a new one. If there is already an issue, feel free to close this one with a pointer to the existing issue. Thanks)

We should add a License field to GAP packages. It would initially be optional, but on the long run mandatory. Several variants for the content of that file come to mind:

  1. A (package relative) path to a license file, e.g.
   License := "COPYING",   # point to our copy of the GPL
  1. The name of the license, say in the form of an SPDX license identifier.
  2. There could actually be two fields: a License field with the license name (SPDX license expression), and a LicenseFile field with file path.

UPDATE: for now we have settled on variant 2, and here is a "roadmap" suggested by @alex-konovalov

@fingolfin fingolfin added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: packages issues or PRs related to package handling, or specific to a package (for packages w/o issue tracker) labels May 9, 2017
@olexandr-konovalov olexandr-konovalov added this to the GAP 4.9.0 milestone Aug 21, 2017
@olexandr-konovalov
Copy link
Member

Shall we try this for GAP 4.9.0? Then packages updating for GAP 4.9.1 would be able to make use of this.

@olexandr-konovalov olexandr-konovalov self-assigned this Aug 21, 2017
@fingolfin
Copy link
Member Author

A pull request for this would be welcome at any time.

@fingolfin
Copy link
Member Author

So, which of my several proposals do you want to implement?

For your plan: Perhaps also notify package authors to add the field, and which values are permissible? This notification could be sent as soon as the master branch implements this, no need to wait for 4.9 (in particular since adding this field will not break compatibility with old GAP versions).
Also, If the license name is to be specified, then we should also state explicitly which value we want for "GPL2 or later", the license most package are using (I think).

@olexandr-konovalov
Copy link
Member

@fingolfin I like the 3rd, both with the file and SPDX id. Agree that we don't actually have to wait for the beta to notify package authors.

@wilfwilson
Copy link
Member

I support the idea of adding these field(s).

@fingolfin
Copy link
Member Author

While this would be nice to have, I don't think it's mandatory for 4.9.0, hence I just removed the milestone. Perhaps we can try to get this into 4.10.0.

@fingolfin fingolfin removed this from the GAP 4.9.0 milestone Nov 8, 2017
@olexandr-konovalov olexandr-konovalov added this to the GAP 4.10.0 milestone Nov 8, 2017
@fingolfin fingolfin removed this from the GAP 4.10.0 milestone Sep 28, 2018
@fingolfin fingolfin added this to the GAP 4.11 milestone Feb 12, 2019
@fingolfin
Copy link
Member Author

I really want to get this done in GAP 4.11. I suggest that we use approach 2., a License field using an SPDX identifier (see https://spdx.org). We can then still add a LicenseFile later on, should we really want to, but don't think it's that useful, while SPDX allows for machine processing and hence can be used to generate info on the website, collect statistics about licenses used in packages, etc.

@olexandr-konovalov
Copy link
Member

@fingolfin this can be closed - all boxes now ticked (one of them transferred to gap-system/GitHubPagesForGAP#17)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes topic: packages issues or PRs related to package handling, or specific to a package (for packages w/o issue tracker)
Projects
None yet
Development

No branches or pull requests

3 participants