mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
3a89bb9b38
GitHub status badge urls no longer allow branch=TAG. Must use branch=BRANCH or tag=TAG. (This was only visible in published description on PyPI.) (Actions job filter still requires branch=TAG_OR_BRANCH)
50 lines
1.5 KiB
Python
50 lines
1.5 KiB
Python
# Hatch custom build hook that generates dynamic readme.
|
|
|
|
import re
|
|
from pathlib import Path
|
|
|
|
from hatchling.metadata.plugin.interface import MetadataHookInterface
|
|
|
|
|
|
def freeze_readme_versions(text: str, version: str) -> str:
|
|
"""
|
|
Rewrite links in readme text to refer to specific version.
|
|
(This assumes version X.Y will be tagged "vX.Y" in git.)
|
|
"""
|
|
release_tag = f"v{version}"
|
|
# (?<=...) is "positive lookbehind": must be there, but won't get replaced
|
|
text = re.sub(
|
|
# GitHub Actions badge: badge.svg?branch=main --> badge.svg?tag=vX.Y.Z:
|
|
r"(?<=badge\.svg\?)branch=main",
|
|
f"tag={release_tag}",
|
|
text,
|
|
)
|
|
return re.sub(
|
|
# GitHub Actions status links: branch:main --> branch:vX.Y.Z:
|
|
r"(?<=branch:)main"
|
|
# ReadTheDocs links: /stable --> /vX.Y.Z:
|
|
r"|(?<=/)stable"
|
|
# ReadTheDocs badge: version=stable --> version=vX.Y.Z:
|
|
r"|(?<=version=)stable",
|
|
release_tag,
|
|
text,
|
|
)
|
|
|
|
|
|
class CustomMetadataHook(MetadataHookInterface):
|
|
def update(self, metadata):
|
|
"""
|
|
Update the project table's metadata.
|
|
"""
|
|
readme_path = Path(self.root) / self.config["readme"]
|
|
content_type = self.config.get("content-type", "text/x-rst")
|
|
version = metadata["version"]
|
|
|
|
readme_text = readme_path.read_text()
|
|
readme_text = freeze_readme_versions(readme_text, version)
|
|
|
|
metadata["readme"] = {
|
|
"content-type": content_type,
|
|
"text": readme_text,
|
|
}
|