Files
rclone/bin/update-authors.py
T
Nick Craig-Wood e7bc3b2483 bin: make update-authors.py add multiple contributors in a single commit
When more than one new contributor is found, list their names in the
commit body rather than making one commit per person.
2026-09-10 16:57:15 +01:00

83 lines
2.2 KiB
Python
Executable File

#!/usr/bin/env python3
"""
Update the authors.md file with the authors from the git log
"""
import re
import subprocess
AUTHORS = "docs/content/authors.md"
IGNORE = "bin/.ignore-emails"
def load(filename):
"""
returns a set of emails already in the file
"""
with open(filename) as fd:
authors = fd.read()
return set(re.findall(r"<(.*?)>", authors))
def add_email(added, name, email):
"""
adds the email passed in to the end of authors.md and records it in added
"""
print("Adding %s <%s>" % (name, email))
with open(AUTHORS, "a+") as fd:
print("- %s <%s>" % (name, email), file=fd)
added.append((name, email))
def commit(added):
"""
commits authors.md with a message describing the names in added
"""
if not added:
return
if len(added) == 1:
message = "Add %s to contributors" % added[0][0]
else:
message = "Add %d new contributors\n\n" % len(added)
message += "".join("- %s\n" % name for name, _ in added)
subprocess.check_call(["git", "commit", "-m", message, AUTHORS])
def main():
# Add emails from authors
out = subprocess.check_output(["git", "log", '--reverse', '--format=%an|%ae', "master"])
out = out.decode("utf-8")
ignored = load(IGNORE)
previous = load(AUTHORS)
previous.update(ignored)
added = []
for line in out.split("\n"):
line = line.strip()
if line == "":
continue
name, email = line.split("|")
if email in previous:
continue
previous.add(email)
add_email(added, name, email)
# Add emails from Co-authored-by: lines
out = subprocess.check_output(["git", "log", '-i', '--grep', 'Co-authored-by:', "master"])
out = out.decode("utf-8")
co_authored_by = re.compile(r"(?i)Co-authored-by:\s+(.*?)\s+<([^>]+)>$")
for line in out.split("\n"):
line = line.strip()
m = co_authored_by.search(line)
if not m:
continue
name, email = m.group(1), m.group(2)
name = name.strip()
email = email.strip()
if email in previous:
continue
previous.add(email)
add_email(added, name, email)
commit(added)
if __name__ == "__main__":
main()