autopub 1.0.0a31__py3-none-any.whl → 1.0.0a33__py3-none-any.whl

autopub/plugins/github.py

@@ -0,0 +1,358 @@
+import json
+import os
+import pathlib
+import textwrap
+from functools import cached_property
+from typing import Optional, TypedDict
+
+from github import Github
+from github.PullRequest import PullRequest
+from github.Repository import Repository
+
+from autopub.exceptions import AutopubException
+from autopub.plugins import AutopubPlugin
+from autopub.types import ReleaseInfo
+
+
+class PRContributors(TypedDict):
+    pr_author: str
+    additional_contributors: set[str]
+    reviewers: set[str]
+
+
+class Sponsors(TypedDict):
+    sponsors: set[str]
+    private_sponsors: int
+
+
+class GithubPlugin(AutopubPlugin):
+    # TODO: think about the config
+    def __init__(self) -> None:
+        super().__init__()
+        
+        self.github_token = os.environ.get("GITHUB_TOKEN")
+        
+        if not self.github_token:
+            raise AutopubException("GITHUB_TOKEN environment variable is required")
+
+        self.repository_name = os.environ.get("GITHUB_REPOSITORY")
+        # TODO: maybe this should be in a config file?
+        self.discussion_category_name = os.environ.get("DISCUSSION_CATEGORY_NAME", "Announcements")
+
+    @cached_property
+    def _github(self) -> Github:
+        return Github(self.github_token)
+
+    @cached_property
+    def _event_data(self) -> Optional[dict]:
+        event_path = os.environ.get("GITHUB_EVENT_PATH")
+        if not event_path:
+            return None
+
+        with open(event_path) as f:
+            return json.load(f)
+
+    @cached_property
+    def repository(self) -> Repository:
+        return self._github.get_repo(self.repository_name)
+
+    @cached_property
+    def pull_request(self) -> Optional[PullRequest]:    
+        pr_number = self._get_pr_number()
+        
+        if pr_number is None:
+            return None
+
+        return self.repository.get_pull(pr_number)
+
+    def _get_pr_number(self) -> Optional[int]:
+        if not self._event_data:
+            return None
+
+        if self._event_data.get("event_name") in [
+            "pull_request",
+            "pull_request_target",
+        ]:
+            return self._event_data["pull_request"]["number"]
+
+        if self._event_data.get("pull_request"):
+            return self._event_data["pull_request"]["number"]
+
+        sha = self._event_data["commits"][0]["id"]
+
+        commit = self.repository.get_commit(sha)
+
+        pulls = commit.get_pulls()
+
+        try:
+            first_pr = pulls[0]
+        except IndexError:
+            return None
+
+        return first_pr.number
+
+    def _update_or_create_comment(
+        self, text: str, marker: str = "<!-- autopub-comment -->"
+    ) -> None:
+        """Update or create a comment on the current PR with the given text."""
+        print(f"Updating or creating comment on PR {self.pull_request} in {self.repository}")
+
+        # Look for existing autopub comment
+        comment_body = f"{marker}\n{text}"
+
+        # Search for existing comment
+        for comment in self.pull_request.get_issue_comments():
+            if marker in comment.body:
+                # Update existing comment
+                comment.edit(comment_body)
+                return
+
+        # Create new comment if none exists
+        self.pull_request.create_issue_comment(comment_body)
+
+    def _get_sponsors(self) -> Sponsors:
+        query_organisation = """
+            query GetSponsors($organization: String!) {
+                organization(login: $organization) {
+                    sponsorshipsAsMaintainer(
+                        first: 100
+                        includePrivate: true
+                        activeOnly: true
+                    ) {
+                        nodes {
+                            privacyLevel
+                            sponsorEntity {
+                                __typename
+                                ... on User {
+                                login
+                            }
+                            ... on Organization {
+                                login
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        """
+
+        query_user = """
+            query GetSponsors($user: String!) {
+                user(login: $user) {
+                    sponsorshipsAsMaintainer(
+                        first: 100
+                        includePrivate: true
+                        activeOnly: true
+                    ) {
+                        nodes {
+                            privacyLevel
+                            sponsorEntity {
+                                __typename
+                                ... on User {
+                                login
+                            }
+                            ... on Organization {
+                                login
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        """
+
+        # TODO: there might be some permission issues in some cases
+        if self.repository.organization:
+            _, response = self._github.requester.graphql_query(
+                query_organisation, {"organization": self.repository.organization.login}
+            )
+
+            data = response["data"]["organization"]["sponsorshipsAsMaintainer"]["nodes"]
+        else:
+            _, response = self._github.requester.graphql_query(
+                query_user, {"user": self.repository.owner.login}
+            )
+
+            data = response["data"]["user"]["sponsorshipsAsMaintainer"]["nodes"]
+
+        sponsors = set()
+        private_sponsors = 0
+
+        for node in data:
+            if node["privacyLevel"] == "PUBLIC":
+                sponsors.add(node["sponsorEntity"]["login"])
+            else:
+                private_sponsors += 1
+
+        return Sponsors(
+            sponsors=sponsors,
+            private_sponsors=private_sponsors,
+        )
+
+    def _get_discussion_category_id(self) -> str:
+
+        query = """
+            query GetDiscussionCategoryId($owner: String!, $repositoryName: String!) {
+                repository(owner: $owner, name: $repositoryName) {
+                    discussionCategories(first:100) {
+                        nodes {
+                            name
+                            id
+                        }
+                    }
+                }
+            }
+        """
+
+        _, response = self._github.requester.graphql_query(
+            query,
+            {
+                "owner": self.repository.owner.login,
+                "repositoryName": self.repository.name,
+            },
+        )
+
+        for node in response["data"]["repository"]["discussionCategories"]["nodes"]:
+            if node["name"] == self.discussion_category_name:
+                return node["id"]
+
+        raise AutopubException(f"Discussion category {self.discussion_category_name} not found")
+
+    def _create_discussion(self, release_info: ReleaseInfo) -> None:
+        mutation = """
+        mutation CreateDiscussion($repositoryId: ID!, $categoryId: ID!, $body: String!, $title: String!) {
+            createDiscussion(input: {repositoryId: $repositoryId, categoryId: $categoryId, body: $body, title: $title}) {
+                discussion {
+                    id
+                }
+            }
+        }
+        """
+
+        self._github.requester.graphql_query(
+            mutation,
+            {
+                # TODO: repo.node_id is not yet been published to pypi
+                "repositoryId": self.repository.raw_data["node_id"],
+                "categoryId": self._get_discussion_category_id(),
+                "body": self._get_release_message(release_info),
+                "title": f"Release {release_info.version}",
+            },
+        )
+
+    def _get_pr_contributors(self) -> PRContributors:
+        pr: PullRequest = self.pull_request
+
+        pr_author = pr.user.login
+        pr_contributors = PRContributors(
+            pr_author=pr_author,
+            additional_contributors=set(),
+            reviewers=set(),
+        )
+
+        for commit in pr.get_commits():
+            if commit.author.login != pr_author:
+                pr_contributors["additional_contributors"].add(commit.author.login)
+
+            for commit_message in commit.commit.message.split("\n"):
+                if commit_message.startswith("Co-authored-by:"):
+                    author = commit_message.split(":")[1].strip()
+                    author_login = author.split(" ")[0]
+
+                    if author_login != pr_author:
+                        pr_contributors["additional_contributors"].add(author_login)
+
+        for review in pr.get_reviews():
+            if review.user.login != pr_author:
+                pr_contributors["reviewers"].add(review.user.login)
+
+        return pr_contributors
+
+    def on_release_notes_valid(
+        self, release_info: ReleaseInfo
+    ) -> None:  # pragma: no cover
+        assert self.pull_request is not None
+
+        contributors = self._get_pr_contributors()
+        sponsors = self._get_sponsors()
+        discussion_category_id = self._get_discussion_category_id()
+
+        message = textwrap.dedent(
+            f"""
+            ## {release_info.version}
+
+            {release_info.release_notes}
+
+            This release was contributed by {contributors} in #{self.pull_request.number}
+
+            Sponsors: {sponsors}
+
+            Discussion: {discussion_category_id}
+            """
+        )
+
+        self._update_or_create_comment(message)
+
+    def on_release_notes_invalid(
+        self, exception: AutopubException
+    ) -> None:  # pragma: no cover
+        # TODO: better message
+        self._update_or_create_comment(str(exception))
+
+    def _get_release_message(self, release_info: ReleaseInfo) -> str:
+        assert self.pull_request is not None
+
+        contributors = self._get_pr_contributors()
+        sponsors = self._get_sponsors()
+
+        message = textwrap.dedent(
+            f"""
+            ## {release_info.version}
+
+            {release_info.release_notes}
+
+            This release was contributed by @{contributors['pr_author']} in #{self.pull_request.number}
+            """
+        )
+
+        if contributors["additional_contributors"]:
+            additional_contributors = [f"@{contributor}" for contributor in contributors["additional_contributors"]]
+            message += f"\n\nAdditional contributors: {', '.join(additional_contributors)}"
+
+        if contributors["reviewers"]:
+            reviewers = [f"@{reviewer}" for reviewer in contributors["reviewers"]]
+            message += f"\n\nReviewers: {', '.join(reviewers)}"
+
+        if sponsors["sponsors"]:
+            sponsors = [f"@{sponsor}" for sponsor in sponsors["sponsors"]]
+            message += f"\n\nThanks to {', '.join(sponsors)}"
+            if sponsors["private_sponsors"]:
+                message += f" and the {sponsors['private_sponsors']} private sponsor(s)"
+
+            message += " for making this release possible ✨"
+
+        return message
+
+    def _create_release(self, release_info: ReleaseInfo) -> None:
+        message = self._get_release_message(release_info)
+
+        release = self.repository.create_git_release(
+            tag=release_info.version,
+            name=release_info.version,
+            message=message,
+        )
+
+        for asset in pathlib.Path("dist").glob("*"):
+            if asset.suffix in [".tar.gz", ".whl"]:
+                release.upload_asset(str(asset))
+
+    def post_publish(self, release_info: ReleaseInfo) -> None:
+        text = f"This PR was published as {release_info.version}"
+        assert self.pull_request is not None
+
+        self._update_or_create_comment(
+            text, marker="<!-- autopub-comment-published -->"
+        )
+
+        self._create_release(release_info)
+        self._create_discussion(release_info)

{autopub-1.0.0a31.dist-info → autopub-1.0.0a33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: autopub
-Version: 1.0.0a31
+Version: 1.0.0a33
 Summary: Automatic package release upon pull request merge
 Home-page: https://github.com/autopub/autopub
 Author: Justin Mayer
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: github
 Requires-Dist: dunamai (>=1.23.0,<2.0.0)
 Requires-Dist: pydantic (>=2.10.5,<3.0.0)
+Requires-Dist: pygithub (>=2.5.0,<3.0.0)
 Requires-Dist: python-frontmatter (>=1.1.0,<2.0.0)
 Requires-Dist: rich (>=13.9.4,<14.0.0)
 Requires-Dist: tomlkit (>=0.13.2,<0.14.0)

{autopub-1.0.0a31.dist-info → autopub-1.0.0a33.dist-info}/RECORD

@@ -5,14 +5,15 @@ autopub/plugin_loader.py,sha256=i8nz0cmu5eaSRJ2Hx5KxbA-tOMR2mjcz8fdRg4zkGLE,1813
 autopub/plugins/__init__.py,sha256=57ewn1lhZYKKuVL49l3cgqAN9LQfCRzdsgSZimIAkls,2030
 autopub/plugins/bump_version.py,sha256=-tTGQR0v8K3Bto1Y8UcmkEs4WnExeF1QyHKHPUKgll8,1565
 autopub/plugins/git.py,sha256=d0SMLc6hwuk0eymj8aHyu3_cEd-7x4fhkwu35wPPV4k,1054
+autopub/plugins/github.py,sha256=5oPTaEuIqwVO2syce7ehDq5g6FTC49rWZWxyJHFO4vg,11824
 autopub/plugins/pdm.py,sha256=Pczye06fKg8_HMJDkEfMXQyvao9rZ7sqzTHFd6lLEpU,532
 autopub/plugins/poetry.py,sha256=d2LvW9RI7ZB3reBOXbcp1mqWmzQ06Uyg_T-MxTvlSBg,517
 autopub/plugins/update_changelog.py,sha256=g_6flOP5wocZbjOaYSayWxobL3ld8f0wT78nFtAIkFc,1586
 autopub/plugins/uv.py,sha256=goo8QxaD3FVJ1c3xOSmN1hikZTCUXN8jWNac1S5uDDY,1089
 autopub/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 autopub/types.py,sha256=gY1WR93XZVFS7vf5JMSmL_h5z7zO51-rtmZ6MYsh3so,1043
-autopub-1.0.0a31.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-autopub-1.0.0a31.dist-info/METADATA,sha256=8Cg6j-bYhkUvxIiabZf-KgwTU5sbr0-5_GIr2qJ75GA,951
-autopub-1.0.0a31.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-autopub-1.0.0a31.dist-info/entry_points.txt,sha256=oeTav5NgCxif6mcZ_HeVGgGv5LzS4DwdI01nr4bO1IM,43
-autopub-1.0.0a31.dist-info/RECORD,,
+autopub-1.0.0a33.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+autopub-1.0.0a33.dist-info/METADATA,sha256=bPk5ktZXuRBe0fQ9Tlzw4htTm9q14Yjr81nAOp0aAFE,992
+autopub-1.0.0a33.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+autopub-1.0.0a33.dist-info/entry_points.txt,sha256=oeTav5NgCxif6mcZ_HeVGgGv5LzS4DwdI01nr4bO1IM,43
+autopub-1.0.0a33.dist-info/RECORD,,