ocaml/dune

Installation of different LICENSE files (per opam package in a multi-opam repository/project)

Open

#4,842 opened on Aug 3, 2021

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)OCaml (478 forks)github user discovery
acknowledgedenhancementhelp wanted

Repository metrics

Stars
 (1,882 stars)
PR merge metrics
 (Avg merge 1d 20h) (345 merged PRs in 30d)

Description

Desired Behavior

I have a git repository with multiple opam packages. Dune constructs the .install files for each of them. Now, some opam packages contain code from other parties that has a different copyright statement and LICENSE.

It would be great if it would be possible that dune installs a separate LICENSE file for each different opam package.

Example

As example, take a look at https://github.com/mirage/mirage-crypto. Especially the mirage-crypto-ec opam package contains vendored code from fiat-crypto and from BoringSSL (and is MIT licensed).

It would be great if dune could check for LICENSE.md., and install this for if it exists - otherwise falling back to LICENSE.md.

Thanks a lot for reading.

Contributor guide

Research direction
Implement detection of per package LICENSE files (e.g., LICENSE.md.<package name>) in the install rules, with fallback to general LICENSE file.
Tech stack
None
Domain
toolingbuild system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70