1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
#
# Copyright:: Copyright 2015-2016, Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require "rake"
SOURCE = File.join(File.dirname(__FILE__), "..", "MAINTAINERS.toml")
TARGET = File.join(File.dirname(__FILE__), "..", "MAINTAINERS.md")
# The list of repositories that teams should own
REPOSITORIES = ["chef/chef", "chef/chef-census", "chef/chef-repo",
"chef/client-docs", "chef/ffi-yajl", "chef/libyajl2-gem",
"chef/mixlib-authentication", "chef/mixlib-cli",
"chef/mixlib-config", "chef/mixlib-install", "chef/mixlib-log",
"chef/mixlib-shellout", "chef/ohai", "chef/omnibus-chef"]
begin
require "tomlrb"
require "octokit"
require "pp"
task :default => :generate
namespace :maintainers do
desc "Generate MarkDown version of MAINTAINERS file"
task :generate do
out = "<!-- This is a generated file. Please do not edit directly -->\n\n"
out << "# " + source["Preamble"]["title"] + "\n\n"
out << source["Preamble"]["text"] + "\n"
# The project lead is a special case
out << "# " + source["Org"]["Lead"]["title"] + "\n\n"
out << format_person(source["Org"]["Lead"]["person"]) + "\n\n"
out << format_components(source["Org"]["Components"])
File.open(TARGET, "w") { |fn|
fn.write out
}
end
desc "Synchronize GitHub teams"
# there's a special @chef/client-maintainers team that's everyone
# and then there's a team per component
task :synchronize do
Octokit.auto_paginate = true
get_github_teams
prepare_teams(source["Org"]["Components"].dup)
sync_teams!
end
end
def github
@github ||= Octokit::Client.new(:netrc => true)
end
def source
@source ||= Tomlrb.load_file SOURCE
end
def teams
@teams ||= { "client-maintainers" => { "title" => "Client Maintainers" } }
end
def add_members(team, name)
teams["client-maintainers"]["members"] ||= []
teams["client-maintainers"]["members"] << name
teams[team] ||= {}
teams[team]["members"] ||= []
teams[team]["members"] << name
end
def set_team_title(team, title)
teams[team] ||= {}
teams[team]["title"] = title
end
def gh_teams
@gh_teams ||= {}
end
# we have to resolve team names to ids. While we're at it, we can get the privacy
# setting, so we know whether we need to update it
def get_github_teams
github.org_teams("chef").each do |team|
gh_teams[team[:slug]] = { "id" => team[:id], "privacy" => team[:privacy] }
end
end
def get_github_team(team)
github.team_members(gh_teams[team]["id"]).map do |member|
member[:login]
end.sort.uniq.map(&:downcase)
rescue
[]
end
def create_team(team)
puts "creating new github team: #{team} with title: #{teams[team]["title"]} "
t = github.create_team("chef", name: team, description: teams[team]["title"],
privacy: "closed", repo_names: REPOSITORIES,
accept: "application/vnd.github.ironman-preview+json")
gh_teams[team] = { "id" => t[:id], "privacy" => t[:privacy] }
end
def compare_teams(current, desired)
# additions are the subtraction of the current state from the desired state
# deletions are the subtraction of the desired state from the current state
[desired - current, current - desired]
end
def prepare_teams(cmp)
%w{text paths}.each { |k| cmp.delete(k) }
if cmp.key?("team")
team = cmp.delete("team")
add_members(team, cmp.delete("lieutenant")) if cmp.key?("lieutenant")
add_members(team, cmp.delete("maintainers")) if cmp.key?("maintainers")
set_team_title(team, cmp.delete("title"))
else
%w{maintainers lieutenant title}.each { |k| cmp.delete(k) }
end
cmp.each { |_k, v| prepare_teams(v) }
end
def update_team(team, additions, deletions)
create_team(team) unless gh_teams.key?(team)
update_team_privacy(team)
add_team_members(team, additions)
remove_team_members(team, deletions)
rescue
puts "failed for #{team}"
end
def update_team_privacy(team)
return if gh_teams[team]["privacy"] == "closed"
puts "Setting #{team} privacy to closed from #{gh_teams[team]["privacy"]}"
github.update_team(gh_teams[team]["id"], privacy: "closed",
accept: "application/vnd.github.ironman-preview+json")
end
def add_team_members(team, additions)
additions.each do |member|
puts "Adding #{member} to #{team}"
github.add_team_membership(gh_teams[team]["id"], member, role: "member",
accept: "application/vnd.github.ironman-preview+json")
end
end
def remove_team_members(team, deletions)
deletions.each do |member|
puts "Removing #{member} from #{team}"
github.remove_team_membership(gh_teams[team]["id"], member,
accept: "application/vnd.github.ironman-preview+json")
end
end
def sync_teams!
teams.each do |name, details|
current = get_github_team(name)
desired = details["members"].flatten.sort.uniq.map(&:downcase)
additions, deletions = compare_teams(current, desired)
update_team(name, additions, deletions)
end
end
def get_person(person)
source["people"][person]
end
def format_components(cmp)
out = "## " + cmp.delete("title") + "\n\n"
out << cmp.delete("text") + "\n" if cmp.has_key?("text")
out << "To mention the team, use @chef/#{cmp.delete("team")}\n\n" if cmp.has_key?("team")
if cmp.has_key?("lieutenant")
out << "### Lieutenant\n\n"
out << format_person(cmp.delete("lieutenant")) + "\n\n"
end
out << format_maintainers(cmp.delete("maintainers")) + "\n" if cmp.has_key?("maintainers")
cmp.delete("paths")
cmp.each { |k, v| out << format_components(v) }
out
end
def format_maintainers(people)
o = "### Maintainers\n\n"
people.each do |p|
o << format_person(p) + "\n"
end
o
end
def format_person(person)
mnt = get_person(person)
"* [#{mnt["Name"]}](https://github.com/#{mnt["GitHub"]})"
end
rescue LoadError
STDERR.puts "\n*** TomlRb not available.\n\n"
end
|
