Add support for custom social message

Author: patrick91

README.md

@@ -5,8 +5,11 @@ AutoPub plugins maintained by Strawberry GraphQL.
 ## Included plugins
 
 - `InviteContributorsPlugin` (`strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin`)
-  - Invites PR contributors to a GitHub organization after `autopub publish`.
-  - Optionally adds them to a team.
+  - 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
 
@@ -16,34 +19,141 @@ pip install strawberry-autopub-plugins
 
 ## Usage
 
-Add the plugin path to your AutoPub config:
+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
-# Optional: extend defaults.
-# By default, skip-bots is true and these users are excluded:
-# dependabot-preview[bot], dependabot-preview, dependabot, dependabot[bot]
 exclude-users = ["renovate[bot]"]
 dry-run = false
 ```
 
-## Required environment variables
+Options:
 
-- `GITHUB_TOKEN`
-- `GITHUB_REPOSITORY`
+- `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
 
-The token must be able to invite users to the target organization.
+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
 
@@ -57,7 +167,3 @@ When changing dependencies, update the lockfile:
 ```bash
 uv lock
 ```
-
-## Next plugin
-
-This repository is structured to host multiple plugins under `src/strawberry_autopub_plugins/`.

src/strawberry_autopub_plugins/typefully.py

@@ -83,16 +83,34 @@ def _format_message(
 
         return message
 
+    def _frontmatter_message_template(self, release_info: ReleaseInfo) -> str | None:
+        additional_info = release_info.additional_info
+        template = additional_info.get("social_message")
+
+        if template is None:
+            template = additional_info.get("social-message")
+
+        if template is None:
+            return None
+
+        if not isinstance(template, str):
+            raise _autopub_error("social_message frontmatter value must be a string")
+
+        if not template.strip():
+            raise _autopub_error("social_message frontmatter value cannot be empty")
+
+        return template
+
     def _build_platforms_payload(
         self,
         release_info: ReleaseInfo,
     ) -> dict[str, object]:
         platforms: dict[str, object] = {}
+        frontmatter_template = self._frontmatter_message_template(release_info)
 
         for platform in self.config.platforms:
-            template = self.config.platform_templates.get(
-                platform,
-                self.config.message_template,
+            template = frontmatter_template or self.config.platform_templates.get(
+                platform, self.config.message_template
             )
             message = self._format_message(template, release_info)
             platforms[platform] = {

tests/test_typefully.py

@@ -15,10 +15,12 @@ def _release_info(
     *,
     version: str | None = "1.0.0",
     previous_version: str | None = "0.9.0",
+    additional_info: dict | None = None,
 ) -> ReleaseInfo:
     return ReleaseInfo(
         release_type="patch",
         release_notes="Bug fixes and improvements",
+        additional_info=additional_info or {},
         version=version,
         previous_version=previous_version,
     )
@@ -168,6 +170,48 @@ def test_custom_message_template(mock_urlopen, monkeypatch) -> None:
     assert body["platforms"]["x"]["posts"][0]["text"] == "v1.0.0 (patch) is out!"
 
 
+@patch("strawberry_autopub_plugins.typefully.urlopen")
+def test_frontmatter_social_message_overrides_templates(mock_urlopen, monkeypatch) -> None:
+    plugin = _plugin_with_config(
+        monkeypatch,
+        config={
+            "platforms": ["x", "linkedin"],
+            "message-template": "Default {version}",
+            "platform-templates": {"linkedin": "LinkedIn {version}"},
+            "project-name": "Strawberry",
+        },
+    )
+
+    plugin.post_publish(
+        _release_info(
+            additional_info={
+                "social_message": "{project_name} {version} shipped\n\n{release_notes}"
+            }
+        )
+    )
+
+    body = _get_request_body(mock_urlopen)
+    assert (
+        body["platforms"]["x"]["posts"][0]["text"]
+        == "Strawberry 1.0.0 shipped\n\nBug fixes and improvements"
+    )
+    assert (
+        body["platforms"]["linkedin"]["posts"][0]["text"]
+        == "Strawberry 1.0.0 shipped\n\nBug fixes and improvements"
+    )
+
+
+def test_frontmatter_social_message_must_be_a_string(monkeypatch) -> None:
+    plugin = _plugin_with_config(monkeypatch)
+
+    with pytest.raises(AutopubException, match="social_message frontmatter value must be a string"):
+        plugin.post_publish(
+            _release_info(
+                additional_info={"social_message": ["not", "a", "string"]},
+            )
+        )
+
+
 @patch("strawberry_autopub_plugins.typefully.urlopen")
 def test_message_truncation(mock_urlopen, monkeypatch) -> None:
     plugin = _plugin_with_config(