From 913bf7fa64ca72620c0419780d902665026470e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Muller?= Date: Thu, 4 Jul 2024 10:07:08 +0200 Subject: [PATCH] Update Readme for automatic javadoc deployment Following the merge of #264, the section about bugfix javadoc is no longer relevant, so I've removed it. --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 47b779e31..02c8ba280 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,7 @@ When a new version of Robolectric is released, the [`docs/javadoc`](docs/javadoc ### Automatic publication -The simplest way to publish the javadoc for a specific version is to [create an issue](https://github.com/robolectric/robolectric.github.io/issues/new) whose title is `Publish javadoc for `, where `` is Robolectric's new version (for example `4.12`). - -> [!NOTE] -> If you provide a bugfix version, it will overwrite the corresponding minor version's javadoc. -> For example, passing version `4.12.2` will update the javadoc for Robolectric 4.12. +The simplest way to publish the javadoc for a specific version is to [create an issue](https://github.com/robolectric/robolectric.github.io/issues/new) whose title is `Publish javadoc for `, where `` is the version you want to deploy (for example `4.12`). This will trigger the [`publish-javadoc.yml` workflow](.github/workflows/publish-javadoc.yml) to build and publish the corresponding javadoc.