Update readme and changelog

builder/src/api/api.ts

@@ -75,6 +75,8 @@ class ExperimentalApiImpl extends ThunderstoreApi {
         packageListingId: string;
         data: {
             categories: string[];
+            readme?: string;
+            changelog?: string;
         };
     }) => {
         const response = await this.post(

builder/src/components/PackageManagement/Modal.tsx

@@ -1,6 +1,11 @@
 import React, { CSSProperties } from "react";
+import { useWatch } from "react-hook-form";
 import { useManagementContext } from "./Context";
-import { PackageListingUpdateForm, usePackageListingUpdateForm } from "./hooks";
+import {
+    PackageListingUpdateForm,
+    PackageListingUpdateFormValues,
+    usePackageListingUpdateForm,
+} from "./hooks";
 import { PackageStatus } from "./PackageStatus";
 import { CategoriesSelect } from "./CategoriesSelect";
 import { DeprecationForm } from "./Deprecation";
@@ -31,6 +36,24 @@ interface BodyProps {
 
 const Body: React.FC<BodyProps> = (props) => {
     const context = useManagementContext().props;
+    const readme = useWatch<PackageListingUpdateFormValues, "readme">({
+        control: props.form.control,
+        name: "readme",
+    });
+    const changelog = useWatch<PackageListingUpdateFormValues, "changelog">({
+        control: props.form.control,
+        name: "changelog",
+    });
+
+    const handleFile = async (e: React.ChangeEvent<HTMLInputElement>, field: "readme" | "changelog") => {
+        const file = e.target.files?.[0];
+        if (!file) {
+            return;
+        }
+
+        const content = await file.text();
+        props.form.setValue(field, { fileName: file.name, content: content });
+    };
 
     return (
         <div className="modal-body">
@@ -49,6 +72,30 @@ const Body: React.FC<BodyProps> = (props) => {
                         <CategoriesSelect form={props.form} />
                     </div>
                 )}
+                <div className="mt-3">
+                    <h6>Update Readme</h6>
+                    <label className="btn btn-primary btn-lg btn-block">
+                        <input
+                            type="file"
+                            accept=".md"
+                            style={{ display: "none" }}
+                            onChange={(e) => handleFile(e, "readme")}
+                        />
+                        {readme?.fileName ?? "Choose File"}
+                    </label>
+                </div>
+                <div className="mt-3">
+                    <h6>Update Changelog</h6>
+                    <label className="btn btn-primary btn-lg btn-block">
+                        <input
+                            type="file"
+                            accept=".md"
+                            style={{ display: "none" }}
+                            onChange={(e) => handleFile(e, "changelog")}
+                        />
+                        {changelog?.fileName ?? "Choose File"}
+                    </label>
+                </div>
             </form>
             {props.form.error && (
                 <div className={"alert alert-danger mt-2 mb-0"}>

builder/src/components/PackageManagement/hooks.ts

@@ -3,14 +3,18 @@ import { ExperimentalApi, UpdatePackageListingResponse } from "../../api";
 import * as Sentry from "@sentry/react";
 import { useState } from "react";
 import { Control } from "react-hook-form/dist/types";
+import { UseFormSetValue } from "react-hook-form";
 
 type Status = undefined | "SUBMITTING" | "SUCCESS" | "ERROR";
 export type PackageListingUpdateFormValues = {
     categories: { value: string; label: string }[];
+    readme?: { fileName: string; content: string };
+    changelog?: { fileName: string; content: string };
 };
 
 export type PackageListingUpdateForm = {
     onSubmit: () => Promise<void>;
+    setValue: UseFormSetValue<PackageListingUpdateFormValues>;
     control: Control<PackageListingUpdateFormValues>;
     error?: string;
     status: Status;
@@ -20,7 +24,7 @@ export const usePackageListingUpdateForm = (
     packageListingId: string,
     onSuccess: (result: UpdatePackageListingResponse) => void
 ): PackageListingUpdateForm => {
-    const { handleSubmit, control } = useForm<PackageListingUpdateFormValues>();
+    const { handleSubmit, control, setValue } = useForm<PackageListingUpdateFormValues>();
     const [status, setStatus] = useState<Status>(undefined);
     const [error, setError] = useState<string | undefined>(undefined);
 
@@ -31,7 +35,11 @@ export const usePackageListingUpdateForm = (
         try {
             const result = await ExperimentalApi.updatePackageListing({
                 packageListingId: packageListingId,
-                data: { categories: data.categories.map((x) => x.value) },
+                data: {
+                    categories: data.categories.map((x) => x.value),
+                    readme: data.readme?.content,
+                    changelog: data.changelog?.content,
+                },
             });
             onSuccess(result);
             setStatus("SUCCESS");
@@ -44,6 +52,7 @@ export const usePackageListingUpdateForm = (
 
     return {
         onSubmit,
+        setValue,
         control,
         error,
         status,

django/thunderstore/api/cyberstorm/tests/test_markdown.py

@@ -71,6 +71,22 @@ def test_readme_api_view__prerenders_markup(api_client: APIClient) -> None:
     assert actual["html"] == "<h1>Very <strong>strong</strong> header</h1>\n"
 
 
+@pytest.mark.django_db
+def test_readme_api_view__uses_override_when_present(api_client: APIClient) -> None:
+    v = PackageVersionFactory(
+        readme="Original",
+        readme_override="Override",
+    )
+
+    response = api_client.get(
+        f"/api/cyberstorm/package/{v.package.namespace}/{v.package.name}/latest/readme/",
+    )
+    actual = response.json()
+
+    # Simple markdown paragraph
+    assert actual["html"] == "<p>Override</p>\n"
+
+
 @pytest.mark.django_db
 @pytest.mark.parametrize(
     ("markdown", "markup"),
@@ -94,6 +110,23 @@ def test_changelog_api_view__prerenders_markup(
     assert actual["html"] == markup
 
 
+@pytest.mark.django_db
+def test_changelog_api_view__uses_override_when_present(
+    api_client: APIClient,
+) -> None:
+    v = PackageVersionFactory(
+        changelog="Original changelog",
+        changelog_override="Override changelog",
+    )
+
+    response = api_client.get(
+        f"/api/cyberstorm/package/{v.package.namespace}/{v.package.name}/latest/changelog/",
+    )
+    actual = response.json()
+
+    assert actual["html"] == "<p>Override changelog</p>\n"
+
+
 @pytest.mark.django_db
 def test_changelog_api_view__when_package_has_no_changelog__returns_404(
     api_client: APIClient,

django/thunderstore/api/cyberstorm/views/markdown.py

@@ -31,6 +31,8 @@ def get_object(self):
             version_number=self.kwargs.get("version_number"),
         )
 
+        if package_version.readme_override is not None:
+            return {"html": render_markdown(package_version.readme_override)}
         return {"html": render_markdown(package_version.readme)}
 
 
@@ -57,6 +59,8 @@ def get_object(self):
         if package_version.changelog is None:
             raise Http404
 
+        if package_version.changelog_override is not None:
+            return {"html": render_markdown(package_version.changelog_override)}
         return {"html": render_markdown(package_version.changelog)}
 
 

django/thunderstore/community/api/experimental/serializers.py

@@ -20,6 +20,16 @@ class PackageListingUpdateRequestSerializer(serializers.Serializer):
         ),
         allow_empty=True,
     )
+    readme = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        allow_null=True,
+    )
+    changelog = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        allow_null=True,
+    )
 
 
 class PackageCategoryExperimentalSerializer(serializers.Serializer):

django/thunderstore/community/api/experimental/tests/test_api_package_listing.py

@@ -6,6 +6,7 @@
 from rest_framework.test import APIClient
 
 from conftest import TestUserTypes
+from thunderstore.cache.enums import CacheBustCondition
 from thunderstore.community.models import PackageCategory, PackageListing
 from thunderstore.repository.models import TeamMember
 
@@ -73,3 +74,45 @@ def test_api_experimental_package_listing_update(
     ]
     assert active_package_listing.categories.count() == 1
     assert package_category in active_package_listing.categories.all()
+
+
+@pytest.mark.django_db
+def test_api_experimental_package_listing_update_overrides_readme_and_changelog(
+    api_client: APIClient,
+    active_package_listing: PackageListing,
+    team_owner: TeamMember,
+    mocker,
+):
+    assert team_owner.team == active_package_listing.package.owner
+    api_client.force_authenticate(user=team_owner.user)
+
+    mocked_invalidate = mocker.patch(
+        "thunderstore.community.api.experimental.views.listing.invalidate_cache_on_commit_async"
+    )
+
+    readme_markdown = "Override readme"
+    changelog_markdown = "Override changelog"
+
+    response = api_client.post(
+        f"/api/experimental/package-listing/{active_package_listing.pk}/update/",
+        data=json.dumps(
+            {
+                "categories": [],
+                "readme": readme_markdown,
+                "changelog": changelog_markdown,
+            }
+        ),
+        content_type="application/json",
+    )
+
+    assert response.status_code == 200
+
+    latest = active_package_listing.package.latest
+    latest.refresh_from_db()
+
+    assert latest.readme_override == readme_markdown
+    assert latest.changelog_override == changelog_markdown
+
+    # Once for readme, once for changelog
+    mocked_invalidate.assert_called_with(CacheBustCondition.any_package_updated)
+    assert mocked_invalidate.call_count == 2

django/thunderstore/community/api/experimental/views/listing.py

@@ -3,6 +3,8 @@
 from rest_framework.generics import GenericAPIView
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
+from thunderstore.cache.tasks import invalidate_cache_on_commit_async
+from thunderstore.cache.enums import CacheBustCondition
 
 from thunderstore.api.cyberstorm.services.package_listing import (
     approve_package_listing,
@@ -45,6 +47,18 @@ def post(self, request, *args, **kwargs):
             listing=listing,
         )
 
+        if "readme" in request_serializer.validated_data:
+            readme = request_serializer.validated_data["readme"]
+            listing.package.latest.readme_override = readme
+            listing.package.latest.save()
+            invalidate_cache_on_commit_async(CacheBustCondition.any_package_updated)
+
+        if "changelog" in request_serializer.validated_data:
+            changelog = request_serializer.validated_data["changelog"]
+            listing.package.latest.changelog_override = changelog
+            listing.package.latest.save()
+            invalidate_cache_on_commit_async(CacheBustCondition.any_package_updated)
+
         serializer = self.serializer_class(instance=listing)
         return Response(serializer.data, status=status.HTTP_200_OK)
 

django/thunderstore/repository/api/experimental/tests/test_package_version.py

@@ -25,6 +25,27 @@ def test_api_experimental_package_version_changelog(
     assert result["markdown"] == changelog
 
 
+@pytest.mark.django_db
+def test_api_experimental_package_version_changelog_uses_override(
+    api_client: APIClient,
+    package_version: PackageVersion,
+) -> None:
+    package_version.changelog = "Base changelog"
+    package_version.changelog_override = "Override changelog"
+    package_version.save()
+
+    response = api_client.get(
+        f"/api/experimental/package/"
+        f"{package_version.package.owner.name}/"
+        f"{package_version.package.name}/"
+        f"{package_version.version_number}/"
+        "changelog/"
+    )
+    assert response.status_code == 200
+    result = response.json()
+    assert result["markdown"] == "Override changelog"
+
+
 @pytest.mark.django_db
 @pytest.mark.parametrize("readme", ("", "# Test readme"))
 def test_api_experimental_package_version_readme(
@@ -42,3 +63,24 @@ def test_api_experimental_package_version_readme(
     assert response.status_code == 200
     result = response.json()
     assert result["markdown"] == readme
+
+
+@pytest.mark.django_db
+def test_api_experimental_package_version_readme_uses_override(
+    api_client: APIClient,
+    package_version: PackageVersion,
+) -> None:
+    package_version.readme = "Base readme"
+    package_version.readme_override = "Override readme"
+    package_version.save()
+
+    response = api_client.get(
+        f"/api/experimental/package/"
+        f"{package_version.package.owner.name}/"
+        f"{package_version.package.name}/"
+        f"{package_version.version_number}/"
+        "readme/"
+    )
+    assert response.status_code == 200
+    result = response.json()
+    assert result["markdown"] == "Override readme"

django/thunderstore/repository/api/experimental/views/package_version.py

@@ -85,7 +85,10 @@ def get(self, *args, **kwargs):
 
     def retrieve(self, request, *args, **kwargs):
         instance = self.get_object()
-        serializer = self.get_serializer({"markdown": instance.changelog})
+        if instance.changelog_override is not None:
+            serializer = self.get_serializer({"markdown": instance.changelog_override})
+        else:
+            serializer = self.get_serializer({"markdown": instance.changelog})
         return Response(serializer.data)
 
 
@@ -105,5 +108,8 @@ def get(self, *args, **kwargs):
 
     def retrieve(self, request, *args, **kwargs):
         instance = self.get_object()
-        serializer = self.get_serializer({"markdown": instance.readme})
+        if instance.readme_override is not None:
+            serializer = self.get_serializer({"markdown": instance.readme_override})
+        else:
+            serializer = self.get_serializer({"markdown": instance.readme})
         return Response(serializer.data)

django/thunderstore/repository/migrations/0065_add_readme_override.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.1.7 on 2026-03-13 20:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('repository', '0064_add_namespaces_for_existing_teams'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='packageversion',
+            name='changelog_override',
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='packageversion',
+            name='readme_override',
+            field=models.TextField(blank=True, null=True),
+        ),
+    ]