Implement /gh release

Author: object-Object

.vscode/python.code-snippets

@@ -0,0 +1,23 @@
+{
+    "Paginated Select": {
+        "prefix": "paginated_select",
+        "body": [
+            "@paginated_select()",
+            "async def $1_select(",
+            "    self,",
+            "    interaction: Interaction,",
+            "    select: PaginatedSelect[Any],",
+            "):",
+            "    ${0:...}",
+            "",
+            "@$1_select.page_getter()",
+            "async def $1_select_page_getter(",
+            "    self,",
+            "    interaction: Interaction,",
+            "    select: PaginatedSelect[Any],",
+            "    page: int,",
+            ") -> list[SelectOption]:",
+            "    ...",
+        ],
+    },
+}

bot/pyproject.toml

@@ -8,7 +8,7 @@ name = "ghutils-bot"
 requires-python = ">=3.12"
 dependencies = [
     "ghutils-common",
-    "discord-py>=2.6.2",
+    "discord-py>=2.6.3",
     "pydantic>=2.7.4",
     "pydantic-settings>=2.3.4",
     "fastapi>=0.111.0",
@@ -21,6 +21,7 @@ dependencies = [
     "pyyaml>=6.0.2",
     "pylette>=4.0.0",
     "humanize>=4.13.0",
+    "babel>=2.17.0",
 ]
 
 [tool.rye]

bot/src/ghutils/cogs/app_commands/github.py

@@ -28,15 +28,17 @@
 from ghutils.ui.components.visibility import MessageVisibility, respond_with_visibility
 from ghutils.ui.embeds.commits import create_commit_embed
 from ghutils.ui.embeds.issues import create_issue_embed
+from ghutils.ui.embeds.releases import create_release_embed, create_release_items
 from ghutils.ui.views.get_artifact import GetArtifactView
+from ghutils.ui.views.get_release import GetReleaseView
 from ghutils.utils.discord.embeds import set_embed_author
 from ghutils.utils.discord.references import (
     CommitReference,
     IssueReference,
     PRReference,
 )
 from ghutils.utils.discord.transformers import RepositoryOption, UserOption
-from ghutils.utils.github import gh_request
+from ghutils.utils.github import ReleaseState, RepositoryName, gh_request
 from ghutils.utils.l10n import translate_text
 
 logger = logging.getLogger(__name__)
@@ -225,6 +227,46 @@ async def user(
 
         await respond_with_visibility(interaction, visibility, embed=embed)
 
+    @app_commands.command()
+    async def release(
+        self,
+        interaction: Interaction,
+        repo: RepositoryOption,
+        tag: str | None = None,
+        visibility: MessageVisibility = "private",
+    ):
+        if not tag:
+            view = await GetReleaseView.new(interaction, repo, visibility)
+            await interaction.response.send_message(view=view, ephemeral=True)
+            return
+
+        async with self.bot.github_app(interaction) as (github, _):
+            try:
+                release = await gh_request(
+                    github.rest.repos.async_get_release_by_tag(
+                        owner=repo.owner.login,
+                        repo=repo.name,
+                        tag=tag,
+                    )
+                )
+            except RequestFailed as e:
+                if e.response.status_code == 404:  # pyright: ignore[reportUnknownMemberType]
+                    raise InvalidInputError(
+                        value=tag,
+                        message="No release found for tag.",
+                    )
+                raise
+
+            repo_name = RepositoryName.from_repo(repo)
+            state = await ReleaseState.of(github, repo_name, release)
+
+            await respond_with_visibility(
+                interaction,
+                visibility,
+                embed=create_release_embed(repo_name, release, state),
+                items=create_release_items(release),
+            )
+
     @app_commands.command()
     async def login(self, interaction: Interaction):
         user_id = interaction.user.id

bot/src/ghutils/resources/l10n/en-US/main.ftl

@@ -64,6 +64,20 @@ gh-user_parameter-description_user =
 gh-user_parameter-description_visibility =
     {-parameter-description_visibility}
 
+# /gh release
+
+gh-release_description =
+    Get a link to a GitHub release, or open a menu to select one.
+
+gh-release_parameter-description_repo =
+    Repository to search in (`owner/repo`).
+
+gh-release_parameter-description_tag =
+    Tag name to get the release for. If not provided, opens a menu to select a release.
+
+gh-release_parameter-description_visibility =
+    {-parameter-description_visibility}
+
 # /gh login
 
 gh-login_description =
@@ -124,7 +138,7 @@ gh-actions_description =
 # /gh actions artifact
 
 gh-actions-artifact_description =
-    Get a link to download a workflow artifact.
+    Open a menu to select a GitHub Actions workflow artifact.
 
 gh-actions-artifact_parameter-description_repo =
     Repository to search in (`owner/repo`).

bot/src/ghutils/ui/components/paginated_select.py

@@ -8,7 +8,9 @@
 from discord.ui import ActionRow, LayoutView, Select, View
 from discord.ui.item import ContainedItemCallbackType
 from discord.ui.select import SelectCallbackDecorator
+from githubkit import Response
 
+from ghutils.utils.github import is_last_page
 from ghutils.utils.types import AsyncCallable
 
 logger = logging.getLogger(__name__)
@@ -17,7 +19,7 @@
 PREVIOUS_PAGE_VALUE = "e4215656-23ba-4a3d-8386-795778944b4b"
 NEXT_PAGE_VALUE = "1e1f5d4c-e908-42cf-8d6c-8b66aadf0998"
 
-MAX_PAGE_LENGTH = 23
+MAX_PER_PAGE = 23
 
 
 type PageGetter[V: View | LayoutView] = AsyncCallable[
@@ -30,6 +32,7 @@ class PaginatedSelect[V: View | LayoutView](Select[V]):
     _inner_callback: ContainedItemCallbackType[V | ActionRow[Any], Self] | None
     _page_getter: PageGetter[V] | None
     _page_cache: dict[int, list[SelectOption]]
+    _placeholder: str | None
 
     _page: int
     _selected_page: int | None
@@ -39,18 +42,22 @@ def __init__(
         self,
         *,
         custom_id: str = MISSING,
-        placeholder: None = None,
+        placeholder: str | None = None,
         min_values: Literal[0, 1] = 1,
         max_values: Literal[0, 1] = 1,
         options: list[SelectOption] = MISSING,
         disabled: bool = False,
-        required: bool = True,
+        required: bool = MISSING,
         row: int | None = None,
         id: int | None = None,
         inner_callback: ContainedItemCallbackType[V | ActionRow[Any], Self]
         | None = None,
         page_getter: PageGetter[V] | None = None,
     ) -> None:
+        # https://github.com/Rapptz/discord.py/issues/10291
+        if required is MISSING:
+            required = min_values > 0
+
         super().__init__(
             custom_id=custom_id,
             placeholder=placeholder,
@@ -70,6 +77,7 @@ def __init__(
         self._inner_callback = inner_callback
         self._page_getter = page_getter
         self._page_cache = {}
+        self._placeholder = placeholder
         self._page = 1
         self._selected_page = None
         self._selected_index = None
@@ -83,6 +91,21 @@ async def fetch_first_page(self, interaction: Interaction):
         self._page_cache.pop(1, None)
         await self._switch_to_page(interaction, 1)
 
+    def set_last_page(self, page: int, response: Response[Any] | None = None) -> bool:
+        """Set the final page. The page after this one is assumed to be empty.
+
+        Page getters can use this if they're returning a page with less than 23 options
+        that they know in advance is the last page, to prevent the select menu from
+        adding a spurious "next page" option to that page.
+
+        If a GitHub response is given, the pagination headers are checked
+        to see if this is the last page or not.
+        """
+        if response is not None and not is_last_page(response):
+            return False
+        self._page_cache[page + 1] = []
+        return True
+
     def clear_cached_pages(self):
         self._page_cache.clear()
 
@@ -117,9 +140,9 @@ def options(self) -> list[SelectOption]:
     @options.setter
     @override
     def options(self, value: list[SelectOption]):
-        if len(value) > MAX_PAGE_LENGTH:
+        if len(value) > MAX_PER_PAGE:
             raise ValueError(
-                f"Pages must not contain more than {MAX_PAGE_LENGTH} options (got {len(value)})"
+                f"Pages must not contain more than {MAX_PER_PAGE} options (got {len(value)})"
             )
 
         assert Select.options.fset is not None
@@ -138,14 +161,14 @@ def options(self, value: list[SelectOption]):
         if self.options and (
             self.options[0].value == PREVIOUS_PAGE_VALUE
             or self.options[-1].value == NEXT_PAGE_VALUE
-            or len(self.options) > MAX_PAGE_LENGTH
+            or len(self.options) > MAX_PER_PAGE
         ):
             return
 
         # NOTE: we need to check this *before* mutating self.options
         if (
             # only allow going to the next page if the current page is full
-            len(self.options) == MAX_PAGE_LENGTH
+            len(self.options) == MAX_PER_PAGE
             # and either the next page has values or we haven't fetched it yet
             and self._page_cache.get(self._page + 1, True)
         ):
@@ -254,9 +277,9 @@ async def _switch_to_page(self, interaction: Interaction, page: int):
             assert self._page_getter
             assert self.view
             options = await self._page_getter(self.view, interaction, self, page)
-            if len(options) > MAX_PAGE_LENGTH:
+            if len(options) > MAX_PER_PAGE:
                 raise ValueError(
-                    f"Pages must not contain more than {MAX_PAGE_LENGTH} options (got {len(options)})"
+                    f"Pages must not contain more than {MAX_PER_PAGE} options (got {len(options)})"
                 )
             self._page_cache[page] = options
 
@@ -279,10 +302,10 @@ async def _switch_to_page(self, interaction: Interaction, page: int):
                 0 if self._selected_page < page else -1
             ].description = f"(selected on page {self._selected_page})"
         else:
-            self.placeholder = None
+            self.placeholder = self._placeholder
 
     def _clear_remote_page_selection(self):
-        self.placeholder = None
+        self.placeholder = self._placeholder
 
         if self.options[0].value == PREVIOUS_PAGE_VALUE:
             self.options[0].description = None
@@ -298,6 +321,7 @@ def paginated_select[
     *,
     options: list[SelectOption] = MISSING,
     custom_id: str = MISSING,
+    placeholder: str | None = None,
     min_values: Literal[0, 1] = 1,
     max_values: Literal[0, 1] = 1,
     disabled: bool = False,
@@ -308,13 +332,21 @@ def decorator(inner_callback: ContainedItemCallbackType[Any, Any]) -> SelectT:
         select = PaginatedSelect[Any](
             options=options,
             custom_id=custom_id,
+            placeholder=placeholder,
             min_values=min_values,
             max_values=max_values,
             disabled=disabled,
             row=row,
             id=id,
             inner_callback=inner_callback,
         )
+
+        # hack: View only adds items as children if __discord_ui_model_type__ is set
+        def model_type(*args: Any, **kwargs: Any):
+            raise AssertionError("This should never be called")
+
+        setattr(select, "__discord_ui_model_type__", model_type)
+
         return select  # pyright: ignore[reportReturnType]
 
     return decorator

bot/src/ghutils/ui/components/refresh.py

@@ -134,7 +134,7 @@ async def callback(self, interaction: Interaction):
                 contents = await create_issue_embeds(github, interaction, self.message)
                 await contents.edit_original_response(interaction, view=self.view)
             except Exception:
-                await interaction.response.edit_message(view=self.view)
+                await interaction.edit_original_response(view=self.view)
                 raise
 
 

bot/src/ghutils/ui/components/visibility.py

@@ -61,6 +61,19 @@ async def send_followup(
             view=self._get_view(interaction, visibility, show_usage),
         )
 
+    async def edit_message(
+        self,
+        interaction: Interaction,
+        visibility: MessageVisibility,
+        show_usage: bool = False,
+    ):
+        await interaction.response.edit_message(
+            content=self.content,
+            embed=self.embed,
+            embeds=self.embeds,
+            view=self._get_view(interaction, visibility, show_usage),
+        )
+
     async def edit_original_response(
         self,
         interaction: Interaction,