Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,33 @@ pkgcheck 0.10.50 (unreleased)
not conditional on ``USE=test``, which run tests with ``USE=-test`` when
allowed by ``ALLOW_TEST`` (Arthur Zamarin, #792)

- PackageMetadataXmlCheck: flag ``UnmarkedProxiedMaintainer``, a maintainer
without a gentoo.org address not marked ``proxied="yes"`` (Matt Turner, #796)

- PackageMetadataXmlCheck: flag ``NonGentooProxy``, a maintainer marked
``proxied="proxy"`` or ``proxied="maintainer-and-proxy"`` without a
gentoo.org address (Matt Turner, #796)

- PackageMetadataXmlCheck: flag ``UnmarkedProxyMaint``, proxy-maint@gentoo.org
listed without ``proxied="proxy"`` (Matt Turner, #796)

- PackageMetadataXmlCheck: flag ``CcOnBugsWithoutEmail``, an upstream
``<maintainer>`` with ``cc-on-bugs="yes"`` and no ``<email>`` (Matt Turner,
#796)

**Fixes:**

- PythonCompatUpdate, RubyCompatUpdate: no longer suggest targets masked in
``profiles/base/use.mask`` (Arthur Zamarin, #791)

- PackageMetadataXmlCheck: no longer crashes on
``proxied="maintainer-and-proxy"`` from GLEP 67 v1.2, and counts such a
maintainer as a proxy (Matt Turner, #796)

- MaintainerWithoutProxy: now also reported when a proxied maintainer
co-maintains with a developer not marked as a proxy, listing only the
proxied maintainers (Matt Turner, #796)

-----------------------------
pkgcheck 0.10.49 (2026-10-24)
-----------------------------
Expand Down
135 changes: 128 additions & 7 deletions src/pkgcheck/checks/metadata_xml.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,11 @@ def desc(self):
class MaintainerWithoutProxy(results.PackageResult, results.Warning):
"""Package has a proxied maintainer without a proxy.

All package maintainers have non-@gentoo.org e-mail addresses. Most likely,
this means that the package is maintained by a proxied maintainer but there
is no explicit proxy (developer or project) listed. This means no Gentoo
developer will be CC-ed on bug reports, and most likely no developer
A maintainer is proxied (``proxied="yes"``, or a non-@gentoo.org e-mail
address without the attribute) but none is a proxy (``proxied="proxy"``
or ``proxied="maintainer-and-proxy"``, or proxy-maint@gentoo.org without the
attribute), which GLEP 67 requires. If no developer is listed either, no
Gentoo developer will be CC-ed on bug reports, and most likely none
oversees the proxied maintainer's activity.
"""

Expand Down Expand Up @@ -141,6 +142,89 @@ def desc(self):
return f"{self.filename}: proxy with no proxied maintainer"


class UnmarkedProxiedMaintainer(results.PackageResult, results.Warning):
"""Package has a non-@gentoo.org maintainer not marked as proxied.

A maintainer without a @gentoo.org e-mail address cannot push changes
directly, so should be listed with ``proxied="yes"``. Without the
attribute, GLEP 67 assumes ``proxied="no"``, which says they can.

An upstream developer listed only to be CC-ed on bugs is not a Gentoo
maintainer. Move them to ``<upstream/>`` with ``cc-on-bugs="yes"``
instead, as described in GLEP 68.
"""

def __init__(self, filename, maintainers, **kwargs):
super().__init__(**kwargs)
self.filename = filename
self.maintainers = tuple(maintainers)

@property
def desc(self):
s = pluralism(self.maintainers)
maintainers = ", ".join(self.maintainers)
return f'{self.filename}: maintainer{s} without proxied="yes": {maintainers}'


class UnmarkedProxyMaint(results.PackageResult, results.Warning):
"""Package lists proxy-maint@gentoo.org without ``proxied="proxy"``.

The Proxy Maintainers project serves only as a proxy for proxied
maintainers, which GLEP 67 expresses as ``proxied="proxy"``. Without
the attribute, ``proxied="no"`` is assumed.
"""

def __init__(self, filename, **kwargs):
super().__init__(**kwargs)
self.filename = filename

@property
def desc(self):
return f'{self.filename}: proxy-maint@gentoo.org without proxied="proxy"'


class NonGentooProxy(results.PackageResult, results.Warning):
"""Package lists a proxy without a @gentoo.org e-mail address.

A proxy pushes changes for proxied maintainers, which needs commit
access. A maintainer without a @gentoo.org e-mail address is most
likely not a Gentoo developer or project, so cannot serve as one.
"""

def __init__(self, filename, maintainers, **kwargs):
super().__init__(**kwargs)
self.filename = filename
self.maintainers = tuple(maintainers)

@property
def desc(self):
ies = pluralism(self.maintainers, singular="y", plural="ies")
maintainers = ", ".join(self.maintainers)
return f"{self.filename}: non-@gentoo.org prox{ies}: {maintainers}"


class CcOnBugsWithoutEmail(results.PackageResult, results.Warning):
"""Package has an upstream maintainer with ``cc-on-bugs="yes"`` but no e-mail.

An upstream maintainer can only be CC-ed on bugs at an e-mail address,
so GLEP 68 requires an ``<email/>`` element when ``cc-on-bugs="yes"``.
"""

def __init__(self, filename, maintainers, **kwargs):
super().__init__(**kwargs)
self.filename = filename
self.maintainers = tuple(maintainers)

@property
def desc(self):
s = pluralism(self.maintainers)
maintainers = ", ".join(self.maintainers)
return (
f'{self.filename}: upstream maintainer{s} with cc-on-bugs="yes" '
f"but no e-mail: {maintainers}"
)


class NonexistentProjectMaintainer(results.PackageResult, results.Warning):
"""Package specifying nonexistent project as a maintainer."""

Expand Down Expand Up @@ -443,6 +527,10 @@ class PackageMetadataXmlCheck(_XmlBaseCheck):
MaintainerNeeded,
MaintainerWithoutProxy,
ProxyWithoutProxied,
UnmarkedProxiedMaintainer,
UnmarkedProxyMaint,
NonGentooProxy,
CcOnBugsWithoutEmail,
RedundantLongDescription,
NonexistentProjectMaintainer,
WrongMaintainerType,
Expand Down Expand Up @@ -515,16 +603,42 @@ def _check_maintainers(self, pkg, loc, doc):

# determine proxy maintainer status
proxied, devs, proxies = [], [], []
proxy_map = {"yes": proxied, "no": devs, "proxy": proxies}
proxy_map = {
"yes": proxied,
"no": devs,
"proxy": proxies,
"maintainer-and-proxy": proxies,
}
for m in pkg.maintainers:
proxy_map[self._maintainer_proxied_key(m)].append(m)

# check proxy maintainers
if not devs and not proxies:
maintainers = sorted(map(str, pkg.maintainers))
if proxied and not proxies:
maintainers = sorted(map(str, proxied))
yield MaintainerWithoutProxy(os.path.basename(loc), maintainers, pkg=pkg)
elif not proxied and proxies:
yield ProxyWithoutProxied(os.path.basename(loc), pkg=pkg)

# check the proxied attributes against the e-mail addresses
unmarked, non_gentoo_proxies = [], []
unmarked_proxy_maint = False
for m in pkg.maintainers:
if m.email.endswith("@gentoo.org"):
if m.email == "proxy-maint@gentoo.org" and m.proxied != "proxy":
unmarked_proxy_maint = True
continue
if m.proxied in ("proxy", "maintainer-and-proxy"):
non_gentoo_proxies.append(str(m))
elif m.proxied != "yes":
unmarked.append(str(m))
if unmarked:
yield UnmarkedProxiedMaintainer(
os.path.basename(loc), sorted(unmarked), pkg=pkg
)
if unmarked_proxy_maint:
yield UnmarkedProxyMaint(os.path.basename(loc), pkg=pkg)
if non_gentoo_proxies:
yield NonGentooProxy(os.path.basename(loc), sorted(non_gentoo_proxies), pkg=pkg)
elif not maintainer_needed:
# check for missing maintainer-needed comment
yield MaintainerNeeded(os.path.basename(loc), maintainer_needed, pkg=pkg)
Expand All @@ -547,6 +661,13 @@ def _check_maintainers(self, pkg, loc, doc):
os.path.basename(loc), sorted(wrong_maintainers), pkg=pkg
)

def _check_upstream_maintainers(self, pkg, loc, doc):
"""Validate upstream maintainers in package metadata."""
xpath = "/pkgmetadata/upstream/maintainer[@cc-on-bugs='yes' and not(email)]"
if maintainers := doc.xpath(xpath):
names = sorted(m.findtext("name", "").strip() for m in maintainers)
yield CcOnBugsWithoutEmail(os.path.basename(loc), names, pkg=pkg)

def _check_longdescription(self, pkg, loc, doc):
if pkg.longdescription is not None:
match_ratio = SequenceMatcher(None, pkg.description, pkg.longdescription).ratio()
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"__class__": "CcOnBugsWithoutEmail", "category": "PackageMetadataXmlCheck", "package": "CcOnBugsWithoutEmail", "filename": "metadata.xml", "maintainers": ["Other Upstream Developer"]}
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
{"__class__": "MaintainerWithoutProxy", "category": "PackageMetadataXmlCheck", "package": "MaintainerWithoutProxy", "filename": "metadata.xml", "maintainers": ["non-gentoo-dev@email.com"]}
{"__class__": "MaintainerWithoutProxy", "category": "PackageMetadataXmlCheck", "package": "MaintainerWithoutProxy2", "filename": "metadata.xml", "maintainers": ["gentoo-dev@gentoo.org"]}
{"__class__": "MaintainerWithoutProxy", "category": "PackageMetadataXmlCheck", "package": "MaintainerWithoutProxy3", "filename": "metadata.xml", "maintainers": ["proxied@example.com"]}
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ diff -Naur gentoo/PackageMetadataXmlCheck/MaintainerWithoutProxy/metadata.xml fi
<maintainer type="person">
<email>non-gentoo-dev@email.com</email>
</maintainer>
+ <maintainer type="person">
+ <email>random-dev@gentoo.org</email>
+ <maintainer type="project" proxied="proxy">
+ <email>proxy-maint@gentoo.org</email>
+ </maintainer>
</pkgmetadata>
diff -Naur gentoo/PackageMetadataXmlCheck/MaintainerWithoutProxy2/metadata.xml fixed/PackageMetadataXmlCheck/MaintainerWithoutProxy2/metadata.xml
Expand All @@ -17,6 +17,18 @@ diff -Naur gentoo/PackageMetadataXmlCheck/MaintainerWithoutProxy2/metadata.xml f
<email>gentoo-dev@gentoo.org</email>
</maintainer>
+ <maintainer type="person" proxied="proxy">
+ <email>committing-dev@email.alt</email>
+ <email>committing-dev@gentoo.org</email>
+ </maintainer>
</pkgmetadata>
diff -Naur gentoo/PackageMetadataXmlCheck/MaintainerWithoutProxy3/metadata.xml fixed/PackageMetadataXmlCheck/MaintainerWithoutProxy3/metadata.xml
--- gentoo/PackageMetadataXmlCheck/MaintainerWithoutProxy3/metadata.xml 2026-11-04 23:37:25.468453444 -0500
+++ fixed/PackageMetadataXmlCheck/MaintainerWithoutProxy3/metadata.xml 2026-11-05 10:00:00.000000000 -0500
@@ -4,7 +4,7 @@
<maintainer type="person" proxied="yes">
<email>proxied@example.com</email>
</maintainer>
- <maintainer type="person">
+ <maintainer type="person" proxied="maintainer-and-proxy">
<email>gentoo-dev@gentoo.org</email>
</maintainer>
</pkgmetadata>
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{"__class__": "NonGentooProxy", "category": "PackageMetadataXmlCheck", "package": "NonGentooProxy", "filename": "metadata.xml", "maintainers": ["proxy@example.org"]}
{"__class__": "NonGentooProxy", "category": "PackageMetadataXmlCheck", "package": "NonGentooProxy2", "filename": "metadata.xml", "maintainers": ["proxy@example.org"]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
diff -Naur gentoo/PackageMetadataXmlCheck/NonGentooProxy/metadata.xml fixed/PackageMetadataXmlCheck/NonGentooProxy/metadata.xml
--- gentoo/PackageMetadataXmlCheck/NonGentooProxy/metadata.xml 2026-11-04 23:40:14.883722217 -0500
+++ fixed/PackageMetadataXmlCheck/NonGentooProxy/metadata.xml 2026-11-04 23:40:14.883829032 -0500
@@ -5,6 +5,6 @@
<email>proxied@example.com</email>
</maintainer>
<maintainer type="person" proxied="proxy">
- <email>proxy@example.org</email>
+ <email>proxy@gentoo.org</email>
</maintainer>
</pkgmetadata>
diff -Naur gentoo/PackageMetadataXmlCheck/NonGentooProxy2/metadata.xml fixed/PackageMetadataXmlCheck/NonGentooProxy2/metadata.xml
--- gentoo/PackageMetadataXmlCheck/NonGentooProxy2/metadata.xml 2026-11-04 23:40:14.883722217 -0500
+++ fixed/PackageMetadataXmlCheck/NonGentooProxy2/metadata.xml 2026-11-04 23:40:14.883829032 -0500
@@ -5,6 +5,6 @@
<email>proxied@example.com</email>
</maintainer>
<maintainer type="person" proxied="maintainer-and-proxy">
- <email>proxy@example.org</email>
+ <email>proxy@gentoo.org</email>
</maintainer>
</pkgmetadata>
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{"__class__": "ProxyWithoutProxied", "category": "PackageMetadataXmlCheck", "package": "ProxyWithoutProxied", "filename": "metadata.xml"}
{"__class__": "ProxyWithoutProxied", "category": "PackageMetadataXmlCheck", "package": "ProxyWithoutProxied2", "filename": "metadata.xml"}
{"__class__": "ProxyWithoutProxied", "category": "PackageMetadataXmlCheck", "package": "ProxyWithoutProxied3", "filename": "metadata.xml"}
{"__class__": "ProxyWithoutProxied", "category": "PackageMetadataXmlCheck", "package": "ProxyWithoutProxied4", "filename": "metadata.xml"}
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,15 @@ diff -Naur gentoo/PackageMetadataXmlCheck/ProxyWithoutProxied3/metadata.xml fixe
- <email>frobnor@gentoo.org</email>
- </maintainer>
</pkgmetadata>
diff -Naur gentoo/PackageMetadataXmlCheck/ProxyWithoutProxied4/metadata.xml fixed/PackageMetadataXmlCheck/ProxyWithoutProxied4/metadata.xml
--- gentoo/PackageMetadataXmlCheck/ProxyWithoutProxied4/metadata.xml 2026-11-07 12:00:00.000000000 -0500
+++ fixed/PackageMetadataXmlCheck/ProxyWithoutProxied4/metadata.xml 2026-11-07 12:00:00.000000000 -0500
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
- <maintainer type="person" proxied="maintainer-and-proxy">
+ <maintainer type="person">
<email>barnor@gentoo.org</email>
</maintainer>
</pkgmetadata>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{"__class__": "UnmarkedProxiedMaintainer", "category": "PackageMetadataXmlCheck", "package": "MaintainerWithoutProxy", "filename": "metadata.xml", "maintainers": ["non-gentoo-dev@email.com"]}
{"__class__": "UnmarkedProxiedMaintainer", "category": "PackageMetadataXmlCheck", "package": "UnmarkedProxiedMaintainer", "filename": "metadata.xml", "maintainers": ["proxied@example.com"]}
{"__class__": "UnmarkedProxiedMaintainer", "category": "PackageMetadataXmlCheck", "package": "UnmarkedProxiedMaintainer2", "filename": "metadata.xml", "maintainers": ["proxied@example.com"]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
diff -Naur gentoo/PackageMetadataXmlCheck/MaintainerWithoutProxy/metadata.xml fixed/PackageMetadataXmlCheck/MaintainerWithoutProxy/metadata.xml
--- gentoo/PackageMetadataXmlCheck/MaintainerWithoutProxy/metadata.xml 2026-11-04 23:40:14.878720665 -0500
+++ fixed/PackageMetadataXmlCheck/MaintainerWithoutProxy/metadata.xml 2026-11-04 23:40:14.878904179 -0500
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
- <maintainer type="person">
+ <maintainer type="person" proxied="yes">
<email>non-gentoo-dev@email.com</email>
</maintainer>
</pkgmetadata>
diff -Naur gentoo/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer/metadata.xml fixed/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer/metadata.xml
--- gentoo/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer/metadata.xml 2026-11-04 23:40:14.878670874 -0500
+++ fixed/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer/metadata.xml 2026-11-04 23:40:14.878928393 -0500
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
- <maintainer type="person">
+ <maintainer type="person" proxied="yes">
<email>proxied@example.com</email>
</maintainer>
<maintainer type="person" proxied="proxy">
diff -Naur gentoo/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer2/metadata.xml fixed/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer2/metadata.xml
--- gentoo/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer2/metadata.xml 2026-11-04 23:40:14.878593833 -0500
+++ fixed/PackageMetadataXmlCheck/UnmarkedProxiedMaintainer2/metadata.xml 2026-11-04 23:40:14.878962847 -0500
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
- <maintainer type="person" proxied="no">
+ <maintainer type="person" proxied="yes">
<email>proxied@example.com</email>
</maintainer>
<maintainer type="person">
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{"__class__": "UnmarkedProxyMaint", "category": "PackageMetadataXmlCheck", "package": "ProxyWithoutProxied", "filename": "metadata.xml"}
{"__class__": "UnmarkedProxyMaint", "category": "PackageMetadataXmlCheck", "package": "UnmarkedProxyMaint", "filename": "metadata.xml"}
{"__class__": "UnmarkedProxyMaint", "category": "PackageMetadataXmlCheck", "package": "UnmarkedProxyMaint2", "filename": "metadata.xml"}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
diff -Naur gentoo/PackageMetadataXmlCheck/ProxyWithoutProxied/metadata.xml fixed/PackageMetadataXmlCheck/ProxyWithoutProxied/metadata.xml
--- gentoo/PackageMetadataXmlCheck/ProxyWithoutProxied/metadata.xml 2026-11-04 23:40:14.881122652 -0500
+++ fixed/PackageMetadataXmlCheck/ProxyWithoutProxied/metadata.xml 2026-11-04 23:40:14.881839371 -0500
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
<pkgmetadata>
- <maintainer type="person">
+ <maintainer type="person" proxied="proxy">
<email>proxy-maint@gentoo.org</email>
</maintainer>
</pkgmetadata>
diff -Naur gentoo/PackageMetadataXmlCheck/UnmarkedProxyMaint/metadata.xml fixed/PackageMetadataXmlCheck/UnmarkedProxyMaint/metadata.xml
--- gentoo/PackageMetadataXmlCheck/UnmarkedProxyMaint/metadata.xml 2026-11-04 23:40:14.881372429 -0500
+++ fixed/PackageMetadataXmlCheck/UnmarkedProxyMaint/metadata.xml 2026-11-04 23:40:14.881904541 -0500
@@ -4,7 +4,7 @@
<maintainer type="person" proxied="yes">
<email>proxied@example.com</email>
</maintainer>
- <maintainer type="person">
+ <maintainer type="person" proxied="proxy">
<email>proxy-maint@gentoo.org</email>
</maintainer>
</pkgmetadata>
diff -Naur gentoo/PackageMetadataXmlCheck/UnmarkedProxyMaint2/metadata.xml fixed/PackageMetadataXmlCheck/UnmarkedProxyMaint2/metadata.xml
--- gentoo/PackageMetadataXmlCheck/UnmarkedProxyMaint2/metadata.xml 2026-11-04 23:40:14.881255522 -0500
+++ fixed/PackageMetadataXmlCheck/UnmarkedProxyMaint2/metadata.xml 2026-11-04 23:40:14.881966081 -0500
@@ -4,7 +4,7 @@
<maintainer type="person" proxied="yes">
<email>proxied@example.com</email>
</maintainer>
- <maintainer type="person" proxied="no">
+ <maintainer type="person" proxied="proxy">
<email>proxy-maint@gentoo.org</email>
</maintainer>
<maintainer type="person" proxied="proxy">
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Copyright 1999-2026 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

DESCRIPTION="Ebuild with a cc-on-bugs upstream maintainer without e-mail in metadata.xml"
HOMEPAGE="https://github.com/pkgcore/pkgcheck"
LICENSE="BSD"
SLOT="0"
Loading
Loading