strawberry-autopub-plugins 0.1.0__tar.gz

strawberry_autopub_plugins-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+.venv/
+.pytest_cache/
+__pycache__/
+*.pyc

strawberry_autopub_plugins-0.1.0/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: strawberry-autopub-plugins
+Version: 0.1.0
+Summary: AutoPub plugins maintained by Strawberry GraphQL
+Author: Strawberry GraphQL
+License: MIT
+Requires-Python: >=3.10
+Requires-Dist: autopub<2.0.0,>=1.0.0a58
+Description-Content-Type: text/markdown
+
+# strawberry-autopub-plugins
+
+AutoPub plugins maintained by Strawberry GraphQL.
+
+## Included plugins
+
+- `InviteContributorsPlugin` (`strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin`)
+  - Invites pull request contributors to a GitHub organization after `autopub publish`.
+  - Can also add invited users to a GitHub team.
+- `TypefullyPlugin` (`strawberry_autopub_plugins.typefully:TypefullyPlugin`)
+  - Creates Typefully drafts or scheduled posts for release announcements.
+  - Supports per-platform templates for `x`, `linkedin`, `threads`, `bluesky`, and `mastodon`.
+
+## Installation
+
+```bash
+pip install strawberry-autopub-plugins
+```
+
+## Usage
+
+Add one or more plugin paths to your AutoPub config:
+
+```toml
+[tool.autopub]
+plugins = [
+  "poetry",
+  "github",
+  "strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin",
+  "strawberry_autopub_plugins.typefully:TypefullyPlugin",
+]
+```
+
+Plugin config is keyed by each plugin's `id`:
+
+- `invite_contributors`
+- `typefully`
+
+## InviteContributorsPlugin
+
+Plugin path:
+
+```text
+strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin
+```
+
+Required environment variables:
+
+- `GITHUB_TOKEN`
+- `GITHUB_REPOSITORY`
+
+Optional environment variables:
+
+- `GITHUB_EVENT_PATH`
+
+`GITHUB_TOKEN` must be able to invite users to the target organization.
+
+Example config:
+
+```toml
+[tool.autopub.plugin_config.invite_contributors]
+organization = "strawberry-graphql"
+team-slug = "strawberry-contributors"
+role = "direct_member"
+skip-bots = true
+include-co-authors = true
+exclude-users = ["renovate[bot]"]
+dry-run = false
+```
+
+Options:
+
+- `organization`: Target GitHub organization. If omitted, the plugin falls back to the repository organization.
+- `team-slug`: Optional team slug to add invited contributors to.
+- `role`: One of `direct_member`, `admin`, or `billing_manager`. Default: `direct_member`.
+- `skip-bots`: Skip logins ending in `[bot]`. Default: `true`.
+- `include-co-authors`: Include `Co-authored-by:` trailers found in commit messages. Default: `true`.
+- `exclude-users`: Additional usernames to skip. Defaults to `dependabot-preview[bot]`, `dependabot-preview`, `dependabot`, and `dependabot[bot]`.
+- `dry-run`: Print which users would be invited without sending invitations. Default: `false`.
+
+## TypefullyPlugin
+
+Plugin path:
+
+```text
+strawberry_autopub_plugins.typefully:TypefullyPlugin
+```
+
+Required environment variables:
+
+- `TYPEFULLY_API_KEY`
+
+Optional environment variables:
+
+- `TYPEFULLY_SOCIAL_SET_ID`
+
+You can provide the social set ID either through `social-set-id` in config or `TYPEFULLY_SOCIAL_SET_ID`.
+
+Example config:
+
+```toml
+[tool.autopub.plugin_config.typefully]
+social-set-id = "abc-123"
+platforms = ["x", "linkedin", "bluesky"]
+project-name = "Strawberry"
+message-template = "{project_name} {version} has been released!\n\n{release_notes}"
+publish-mode = "draft"
+tags = ["release", "python"]
+max-length = 280
+truncation-suffix = "..."
+dry-run = false
+
+[tool.autopub.plugin_config.typefully.platform-templates]
+x = "{project_name} {version} is out now.\n\n{release_notes}"
+linkedin = "{project_name} {version} has been released.\n\n{release_notes}"
+```
+
+Options:
+
+- `social-set-id`: Typefully social set to post into. Required unless `TYPEFULLY_SOCIAL_SET_ID` is set.
+- `platforms`: Platforms to enable. Supported values: `x`, `linkedin`, `threads`, `bluesky`, `mastodon`. Default: `["x"]`.
+- `message-template`: Default template for all platforms. Default: `{project_name} {version} has been released!\n\n{release_notes}`.
+- `platform-templates`: Per-platform template overrides.
+- `project-name`: Value exposed to templates as `{project_name}`.
+- `publish-mode`: One of `draft`, `now`, `next-free-slot`, or `scheduled`. Default: `draft`.
+- `publish-at`: Required when `publish-mode = "scheduled"`.
+- `tags`: Optional Typefully tags to attach to the draft.
+- `max-length`: Maximum post length before truncation. Default: `280`.
+- `truncation-suffix`: Suffix appended after truncation. Default: `...`.
+- `dry-run`: Print the request body without calling the Typefully API. Default: `false`.
+
+Template variables:
+
+- `{project_name}`
+- `{version}`
+- `{release_type}`
+- `{release_notes}`
+- `{previous_version}`
+
+Release-specific override from `RELEASE.md` frontmatter:
+
+```md
+---
+release type: patch
+social_message: |
+  Strawberry {version} is out now.
+
+  Highlights:
+  {release_notes}
+---
+
+- Fixed X
+- Added Y
+```
+
+When `social_message` is present in AutoPub frontmatter, the plugin uses it as the message template for all configured platforms and still expands the same template variables listed above.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+```
+
+When changing dependencies, update the lockfile:
+
+```bash
+uv lock
+```

strawberry_autopub_plugins-0.1.0/README.md

@@ -0,0 +1,169 @@
+# strawberry-autopub-plugins
+
+AutoPub plugins maintained by Strawberry GraphQL.
+
+## Included plugins
+
+- `InviteContributorsPlugin` (`strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin`)
+  - Invites pull request contributors to a GitHub organization after `autopub publish`.
+  - Can also add invited users to a GitHub team.
+- `TypefullyPlugin` (`strawberry_autopub_plugins.typefully:TypefullyPlugin`)
+  - Creates Typefully drafts or scheduled posts for release announcements.
+  - Supports per-platform templates for `x`, `linkedin`, `threads`, `bluesky`, and `mastodon`.
+
+## Installation
+
+```bash
+pip install strawberry-autopub-plugins
+```
+
+## Usage
+
+Add one or more plugin paths to your AutoPub config:
+
+```toml
+[tool.autopub]
+plugins = [
+  "poetry",
+  "github",
+  "strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin",
+  "strawberry_autopub_plugins.typefully:TypefullyPlugin",
+]
+```
+
+Plugin config is keyed by each plugin's `id`:
+
+- `invite_contributors`
+- `typefully`
+
+## InviteContributorsPlugin
+
+Plugin path:
+
+```text
+strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin
+```
+
+Required environment variables:
+
+- `GITHUB_TOKEN`
+- `GITHUB_REPOSITORY`
+
+Optional environment variables:
+
+- `GITHUB_EVENT_PATH`
+
+`GITHUB_TOKEN` must be able to invite users to the target organization.
+
+Example config:
+
+```toml
+[tool.autopub.plugin_config.invite_contributors]
+organization = "strawberry-graphql"
+team-slug = "strawberry-contributors"
+role = "direct_member"
+skip-bots = true
+include-co-authors = true
+exclude-users = ["renovate[bot]"]
+dry-run = false
+```
+
+Options:
+
+- `organization`: Target GitHub organization. If omitted, the plugin falls back to the repository organization.
+- `team-slug`: Optional team slug to add invited contributors to.
+- `role`: One of `direct_member`, `admin`, or `billing_manager`. Default: `direct_member`.
+- `skip-bots`: Skip logins ending in `[bot]`. Default: `true`.
+- `include-co-authors`: Include `Co-authored-by:` trailers found in commit messages. Default: `true`.
+- `exclude-users`: Additional usernames to skip. Defaults to `dependabot-preview[bot]`, `dependabot-preview`, `dependabot`, and `dependabot[bot]`.
+- `dry-run`: Print which users would be invited without sending invitations. Default: `false`.
+
+## TypefullyPlugin
+
+Plugin path:
+
+```text
+strawberry_autopub_plugins.typefully:TypefullyPlugin
+```
+
+Required environment variables:
+
+- `TYPEFULLY_API_KEY`
+
+Optional environment variables:
+
+- `TYPEFULLY_SOCIAL_SET_ID`
+
+You can provide the social set ID either through `social-set-id` in config or `TYPEFULLY_SOCIAL_SET_ID`.
+
+Example config:
+
+```toml
+[tool.autopub.plugin_config.typefully]
+social-set-id = "abc-123"
+platforms = ["x", "linkedin", "bluesky"]
+project-name = "Strawberry"
+message-template = "{project_name} {version} has been released!\n\n{release_notes}"
+publish-mode = "draft"
+tags = ["release", "python"]
+max-length = 280
+truncation-suffix = "..."
+dry-run = false
+
+[tool.autopub.plugin_config.typefully.platform-templates]
+x = "{project_name} {version} is out now.\n\n{release_notes}"
+linkedin = "{project_name} {version} has been released.\n\n{release_notes}"
+```
+
+Options:
+
+- `social-set-id`: Typefully social set to post into. Required unless `TYPEFULLY_SOCIAL_SET_ID` is set.
+- `platforms`: Platforms to enable. Supported values: `x`, `linkedin`, `threads`, `bluesky`, `mastodon`. Default: `["x"]`.
+- `message-template`: Default template for all platforms. Default: `{project_name} {version} has been released!\n\n{release_notes}`.
+- `platform-templates`: Per-platform template overrides.
+- `project-name`: Value exposed to templates as `{project_name}`.
+- `publish-mode`: One of `draft`, `now`, `next-free-slot`, or `scheduled`. Default: `draft`.
+- `publish-at`: Required when `publish-mode = "scheduled"`.
+- `tags`: Optional Typefully tags to attach to the draft.
+- `max-length`: Maximum post length before truncation. Default: `280`.
+- `truncation-suffix`: Suffix appended after truncation. Default: `...`.
+- `dry-run`: Print the request body without calling the Typefully API. Default: `false`.
+
+Template variables:
+
+- `{project_name}`
+- `{version}`
+- `{release_type}`
+- `{release_notes}`
+- `{previous_version}`
+
+Release-specific override from `RELEASE.md` frontmatter:
+
+```md
+---
+release type: patch
+social_message: |
+  Strawberry {version} is out now.
+
+  Highlights:
+  {release_notes}
+---
+
+- Fixed X
+- Added Y
+```
+
+When `social_message` is present in AutoPub frontmatter, the plugin uses it as the message template for all configured platforms and still expands the same template variables listed above.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+```
+
+When changing dependencies, update the lockfile:
+
+```bash
+uv lock
+```

strawberry_autopub_plugins-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["hatchling>=1.27.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "strawberry-autopub-plugins"
+version = "0.1.0"
+description = "AutoPub plugins maintained by Strawberry GraphQL"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [
+  { name = "Strawberry GraphQL" }
+]
+dependencies = [
+  "autopub>=1.0.0a58,<2.0.0",
+]
+
+[dependency-groups]
+dev = [
+  "pytest>=8.0.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/strawberry_autopub_plugins"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

strawberry_autopub_plugins-0.1.0/src/strawberry_autopub_plugins/__init__.py

@@ -0,0 +1,6 @@
+"""AutoPub plugins for Strawberry GraphQL."""
+
+from strawberry_autopub_plugins.invite_contributors import InviteContributorsPlugin
+from strawberry_autopub_plugins.typefully import TypefullyPlugin
+
+__all__ = ["InviteContributorsPlugin", "TypefullyPlugin"]

strawberry_autopub_plugins-0.1.0/src/strawberry_autopub_plugins/invite_contributors.py

@@ -0,0 +1,213 @@
+from __future__ import annotations
+
+import json
+import os
+from functools import cached_property
+from typing import Literal
+
+from github import Github
+from github.GithubException import GithubException
+from github.Organization import Organization
+from github.PullRequest import PullRequest
+from github.Repository import Repository
+from github.Team import Team
+from pydantic import BaseModel, Field
+
+from autopub.exceptions import AutopubException
+from autopub.plugins import AutopubPlugin
+from autopub.types import ReleaseInfo
+
+
+KNOWN_BOT_EXCLUSIONS = [
+    "dependabot-preview[bot]",
+    "dependabot-preview",
+    "dependabot",
+    "dependabot[bot]",
+]
+
+
+class InviteContributorsConfig(BaseModel):
+    organization: str | None = None
+    team_slug: str | None = Field(default=None, validation_alias="team-slug")
+    role: Literal["direct_member", "admin", "billing_manager"] = "direct_member"
+    skip_bots: bool = Field(default=True, validation_alias="skip-bots")
+    include_co_authors: bool = Field(
+        default=True,
+        validation_alias="include-co-authors",
+    )
+    exclude_users: list[str] = Field(
+        default_factory=lambda: list(KNOWN_BOT_EXCLUSIONS),
+        validation_alias="exclude-users",
+    )
+    dry_run: bool = Field(default=False, validation_alias="dry-run")
+
+
+class InviteContributorsPlugin(AutopubPlugin):
+    """Invite PR contributors to a GitHub organization (and optional team)."""
+
+    id = "invite_contributors"
+    Config = InviteContributorsConfig
+
+    def __init__(self) -> None:
+        self.github_token = os.environ.get("GITHUB_TOKEN")
+        self.repository_name = os.environ.get("GITHUB_REPOSITORY")
+
+        if not self.github_token:
+            raise AutopubException("GITHUB_TOKEN environment variable is required")
+
+        if not self.repository_name:
+            raise AutopubException("GITHUB_REPOSITORY environment variable is required")
+
+    @cached_property
+    def _github(self) -> Github:
+        return Github(self.github_token)
+
+    @cached_property
+    def _event_data(self) -> dict | None:
+        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) -> PullRequest | None:
+        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) -> int | None:
+        if not self._event_data:
+            return None
+
+        if self._event_data.get("pull_request"):
+            return self._event_data["pull_request"]["number"]
+
+        if self._event_data.get("head_commit"):
+            sha = self._event_data["head_commit"]["id"]
+        else:
+            commits = self._event_data.get("commits", [])
+            if not commits:
+                return None
+            sha = commits[0]["id"]
+
+        commit = self.repository.get_commit(sha)
+        pulls = commit.get_pulls()
+
+        try:
+            return pulls[0].number
+        except IndexError:
+            return None
+
+    def _get_pr_contributors(self, pr: PullRequest) -> set[str]:
+        contributors: set[str] = {pr.user.login}
+
+        for commit in pr.get_commits():
+            author = getattr(commit, "author", None)
+            if author and getattr(author, "login", None):
+                contributors.add(author.login)
+
+            if self.config.include_co_authors:
+                for line in commit.commit.message.splitlines():
+                    if not line.startswith("Co-authored-by:"):
+                        continue
+
+                    trailer_value = line.split(":", 1)[1].strip()
+                    login = trailer_value.split(" ", 1)[0].lstrip("@")
+
+                    if login:
+                        contributors.add(login)
+
+        return contributors
+
+    def _filter_contributors(self, contributors: set[str]) -> list[str]:
+        excluded_users = set(self.config.exclude_users)
+        filtered = []
+
+        for login in sorted(contributors):
+            if login in excluded_users:
+                continue
+
+            if self.config.skip_bots and login.endswith("[bot]"):
+                continue
+
+            filtered.append(login)
+
+        return filtered
+
+    def _resolve_organization(self) -> Organization:
+        if self.config.organization:
+            return self._github.get_organization(self.config.organization)
+
+        if self.repository.organization:
+            return self._github.get_organization(self.repository.organization.login)
+
+        raise AutopubException(
+            "No organization configured. Set tool.autopub.plugin_config"
+            ".invite_contributors.organization"
+        )
+
+    def _resolve_team(self, organization: Organization) -> Team | None:
+        if not self.config.team_slug:
+            return None
+
+        return organization.get_team_by_slug(self.config.team_slug)
+
+    def _invite_login(self, organization: Organization, team: Team | None, login: str) -> None:
+        user = self._github.get_user(login)
+
+        invite_kwargs: dict[str, object] = {
+            "user": user,
+            "role": self.config.role,
+        }
+
+        if team is not None:
+            invite_kwargs["teams"] = [team]
+
+        try:
+            organization.invite_user(**invite_kwargs)
+        except GithubException as exc:
+            # 422 usually means already invited or already a member.
+            if exc.status == 422:
+                return
+
+            message = str(exc)
+            if isinstance(exc.data, dict):
+                message = exc.data.get("message", message)
+
+            raise AutopubException(f"Failed to invite @{login}: {message}") from exc
+
+    def post_publish(self, release_info: ReleaseInfo) -> None:
+        del release_info
+
+        pr = self.pull_request
+        if pr is None:
+            return
+
+        contributors = self._get_pr_contributors(pr)
+        contributors_to_invite = self._filter_contributors(contributors)
+
+        if not contributors_to_invite:
+            return
+
+        organization = self._resolve_organization()
+        team = self._resolve_team(organization)
+
+        for login in contributors_to_invite:
+            if self.config.dry_run:
+                print(f"[invite_contributors] would invite @{login}")
+                continue
+
+            self._invite_login(organization, team, login)
+
+
+__all__ = ["InviteContributorsPlugin"]