Skip to content

Commit

Permalink
Update Readme for automatic javadoc deployment
Browse files Browse the repository at this point in the history
Following the merge of robolectric#264, the section about bugfix javadoc is no longer relevant, so I've removed it.
  • Loading branch information
MGaetan89 authored and utzcoz committed Jul 4, 2024
1 parent 8a48f46 commit 913bf7f
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <version>`, where `<version>` 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 <version>`, where `<version>` 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.

Expand Down

0 comments on commit 913bf7f

Please sign in to comment.