Skip to content

Commit beea68f

Browse files
authored
Encourage adding email in author & maintainer info (#10848)
For packages submitted to the opam-repository, it would help to have the email addresses of the maintainers. See ocaml/infrastructure#152. This commit subtly encourages package authors/maintainers to do so. Signed-off-by: Puneeth Chaganti <[email protected]>
1 parent 28fe966 commit beea68f

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

src/dune_lang/package_info.ml

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ let example =
4545
{ source =
4646
Some (Host (Source_kind.Host.Github { user = "username"; repo = "reponame" }))
4747
; license = Some [ "LICENSE" ]
48-
; authors = Some [ "Author Name" ]
49-
; maintainers = Some [ "Maintainer Name" ]
48+
; authors = Some [ "Author Name <[email protected]>" ]
49+
; maintainers = Some [ "Maintainer Name <[email protected]>" ]
5050
; documentation =
5151
Some "https://url/to/documentation"
5252
(* homepage and bug_reports are inferred from the source *)

test/blackbox-tests/test-cases/dune-init.t/run.t

+8-8
Original file line numberDiff line numberDiff line change
@@ -345,9 +345,9 @@ In particular, the `dune-project` file has the expected content:
345345
(source
346346
(github username/reponame))
347347

348-
(authors "Author Name")
348+
(authors "Author Name <author@example.com>")
349349

350-
(maintainers "Maintainer Name")
350+
(maintainers "Maintainer Name <maintainer@example.com>")
351351

352352
(license LICENSE)
353353

@@ -376,8 +376,8 @@ And the opam file will be generated as expected
376376
opam-version: "2.0"
377377
synopsis: "A short synopsis"
378378
description: "A longer description"
379-
maintainer: ["Maintainer Name"]
380-
authors: ["Author Name"]
379+
maintainer: ["Maintainer Name <maintainer@example.com>"]
380+
authors: ["Author Name <author@example.com>"]
381381
license: "LICENSE"
382382
tags: ["topics" "to describe" "your" "project"]
383383
homepage: "https://github.com/username/reponame"
@@ -455,9 +455,9 @@ In particular, the `dune-project` file has the expected content:
455455
(source
456456
(github username/reponame))
457457

458-
(authors "Author Name")
458+
(authors "Author Name <author@example.com>")
459459

460-
(maintainers "Maintainer Name")
460+
(maintainers "Maintainer Name <maintainer@example.com>")
461461

462462
(license LICENSE)
463463

@@ -486,8 +486,8 @@ And the opam file will be generated as expected
486486
opam-version: "2.0"
487487
synopsis: "A short synopsis"
488488
description: "A longer description"
489-
maintainer: ["Maintainer Name"]
490-
authors: ["Author Name"]
489+
maintainer: ["Maintainer Name <maintainer@example.com>"]
490+
authors: ["Author Name <author@example.com>"]
491491
license: "LICENSE"
492492
tags: ["topics" "to describe" "your" "project"]
493493
homepage: "https://github.com/username/reponame"

0 commit comments

Comments
 (0)