diff --git a/docs/contributing.rst b/docs/contributing.rst index ef6fad1..a6b7ec8 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -172,3 +172,37 @@ We use `HTMX `_ for dynamically loading content, and `Hyperscript `_ for most interactions rather than raw JavaScript. If you can accomplish what you need with these tools, please use them rather than adding JS. + + +Cutting a release +----------------- + +In order to make a release of Takahē, follow these steps: + +* Create or update the release document (in ``/docs/releases``) for the + release; major versions get their own document, minor releases get a + subheading in the document for their major release. + + * Go through the git commit history since the last release in order to write + a reasonable summary of features. + + * Be sure to include the little paragraphs at the end about contributing and + the docker tag, and an Upgrade Notes section that at minimum mentions + migrations and if they're normal or weird (even if there aren't any, it's + nice to call that out). + + * If it's a new doc, make sure you include it in ``docs/releases/index.rst``! + +* Update the version number in ``/takahe/__init__.py`` + +* Update the version number in ``README.md`` + +* Make a commit containing these changes called ``Releasing 1.23.45``. + +* Tag that commit with a tag in the format ``1.23.45``. + +* Wait for the GitHub Actions to run and publish the docker images (around 20 + minutes as the ARM build is a bit slow) + +* Post on the official account announcing the relase and linking to the + now-published release notes. diff --git a/docs/releases/0.11.rst b/docs/releases/0.11.rst index d0e6065..0b39c17 100644 --- a/docs/releases/0.11.rst +++ b/docs/releases/0.11.rst @@ -35,3 +35,20 @@ In additions, there's many bugfixes and minor changes, including: * Perform some basic domain validity * Correctly reject more operations when the identity is deleted * Post edit fanouts for likers/boosters + + +If you'd like to help with code, design, or other areas, see +:doc:`/contributing` to see how to get in touch. + +You can download images from `Docker Hub `_, +or use the image name ``jointakahe/takahe:0.11``. + + +Upgrade Notes +------------- + +Migrations +~~~~~~~~~~ + +There are new database migrations; they are backwards-compatible and should +not present any major database load. diff --git a/takahe/__init__.py b/takahe/__init__.py index 1f4c4d4..ae6db5f 100644 --- a/takahe/__init__.py +++ b/takahe/__init__.py @@ -1 +1 @@ -__version__ = "0.10.1" +__version__ = "0.11.0"