manifesto icon indicating copy to clipboard operation
manifesto copied to clipboard

Adopt a standard encoding of license names in project metadata and OPAM packages

Open palmskog opened this issue 6 years ago • 6 comments

Meta-issue

As highlighted by @Zimmi48 in a recent pull request, we are currently using informal conventions to indicate project licenses in OPAM files, e.g., LGPL 3 and LGPL2.

To address this, I opened an issue in the Coq OPAM archive, which is the intended home for OPAM packages in Coq-community. As suggested by @Zimmi48, I proposed the archive should use the SPDX license name format, which is used by Elm packages.

Since we are dependent on the Coq OPAM archive for distribution, I believe we should wait to enforce SPDX until they have switched, rather than unilaterally adopting it and making the archive even less uniform in license naming.

palmskog avatar Dec 15 '18 04:12 palmskog

Note that projects can already start to use the SPDX license full names (used only in README.md) and include the SPDX license identifier in meta.yml as additional metadata. For example, in AAC tactics:

license:
  fullname: GNU General Public License v3.0 or later
  identifier: GPL-3.0-or-later
  shortname: GPL 3

palmskog avatar Dec 18 '18 17:12 palmskog

Right. We can then remove the "shortname" later on if there is a decision to standardize opam packages to use SPDX as well.

Zimmi48 avatar Dec 18 '18 18:12 Zimmi48

For anyone following this (and for posterity), I have talked to the Coq OPAM repo maintainer, and we've decided to to use SPDX license strings for all Coq-community OPAM packages from now on. Conversion of old packages will happen as we go along.

palmskog avatar Feb 05 '19 22:02 palmskog

When should we close this issue?

Zimmi48 avatar Feb 06 '19 08:02 Zimmi48

I think we should close this issue when:

  • [ ] we have properly documented our SPDX requirements for projects
  • [ ] all Coq-community projects have a meta.yml which contains an SPDX identifier
  • [ ] all Coq-community OPAM packages have migrated to using SPDX identifiers

palmskog avatar Mar 01 '19 19:03 palmskog

We have a coq-community package (math-classes) that is not under an “open source” license per se but has a non-standard public domain dedication, thus it has no SPDX identifier. Since public domain allows everything, including changing the license, we should put a standard public domain license such as CC-0 or the Unlicense which both have a SPDX identifier.

Zimmi48 avatar Mar 05 '19 09:03 Zimmi48