Merge pull request #384 from oxinabox/ox/codeowners

Add CodeOwners Plugin

Author: iamed2

Project.toml

@@ -1,7 +1,7 @@
 name = "PkgTemplates"
 uuid = "14b8a8f1-9102-5b29-a752-f990bacb7fe1"
 authors = ["Chris de Graaf", "Invenia Technical Computing Corporation"]
-version = "0.7.30"
+version = "0.7.31"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/PkgTemplates.jl

@@ -22,6 +22,7 @@ export
     CirrusCI,
     Citation,
     Codecov,
+    CodeOwners,
     ColPracBadge,
     CompatHelper,
     Coveralls,

src/plugin.jl

@@ -355,6 +355,7 @@ include(joinpath("plugins", "git.jl"))
 include(joinpath("plugins", "tagbot.jl"))
 include(joinpath("plugins", "develop.jl"))
 include(joinpath("plugins", "coverage.jl"))
+include(joinpath("plugins", "codeowners.jl"))
 include(joinpath("plugins", "ci.jl"))
 include(joinpath("plugins", "compat_helper.jl"))
 include(joinpath("plugins", "citation.jl"))

src/plugins/codeowners.jl

@@ -0,0 +1,39 @@
+"""
+    CodeOwners <: Plugin
+    CodeOwners(; owners)
+
+A plugin which created GitLab/GitHub compatible CODEOWNERS files.
+owners should be a vector of patterns mapped to a vector of owner names.
+For example:
+`owners=["*"=>["@invenia"], "README.md"=>["@documentation","@oxinabox]]`
+assigns general ownership over all files to the invenia group,
+but assigns ownership of the readme to the documentation group and to the user oxinabox.
+
+By default, it creates an empty CODEOWNERS file.
+"""
+@plugin struct CodeOwners <: Plugin
+    owners::Vector{Pair{String,Vector{String}}} = Vector{Pair{String,Vector{String}}}()
+end
+
+PkgTemplates.destination(::CodeOwners) = "CODEOWNERS"
+
+function render_plugin(p::CodeOwners)
+    join((pattern * " " * join(subowners, " ") for (pattern, subowners) in p.owners), "\n")
+end
+
+function PkgTemplates.hook(p::CodeOwners, t::Template, pkg_dir::AbstractString)
+    pkg = basename(pkg_dir)
+    path = joinpath(pkg_dir, destination(p))
+    text = render_plugin(p)
+    PkgTemplates.gen_file(path, text)
+end
+
+function PkgTemplates.validate(p::CodeOwners, ::Template)
+    for (pattern, subowners) in p.owners
+        contains(pattern, r"\s") && throw(ArgumentError(("Pattern ($pattern) must not contain whitespace")))
+        for subowner in subowners
+            contains(subowner, r"\s") && throw(ArgumentError("Owner name ($subowner) must not contain whitespace"))
+            '@' ∈ subowner || throw(ArgumentError("Owner name ($subowner) must be `@user` or `[email protected]`"))
+        end
+    end
+end

test/fixtures/AllPlugins/CODEOWNERS

@@ -0,0 +1 @@
+

test/fixtures/WackyOptions/CODEOWNERS

@@ -0,0 +1,2 @@
+* @user
+README.md @group [email protected]

test/reference.jl

@@ -88,7 +88,7 @@ end
 
     @testset "All plugins" begin
         test_all("AllPlugins"; authors=USER, plugins=[
-            AppVeyor(), CirrusCI(), Citation(), Codecov(), CompatHelper(), Coveralls(),
+            AppVeyor(), CirrusCI(), Citation(), Codecov(), CompatHelper(), Coveralls(), CodeOwners(),
             Develop(), Documenter(), DroneCI(), GitHubActions(), GitLabCI(), TravisCI(), RegisterAction(),
         ])
     end
@@ -117,6 +117,7 @@ end
             CirrusCI(; image="freebsd-123", coverage=false, extra_versions=["1.3"]),
             Citation(; readme=true),
             Codecov(; file=STATIC_TXT),
+            CodeOwners(; owners=["*"=>["@user"], "README.md"=>["@group","[email protected]"]]),
             CompatHelper(; cron="0 0 */3 * *"),
             Coveralls(; file=STATIC_TXT),
             Documenter{GitHubActions}(;