aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorFabian Meumertzheim <fabian@meumertzhe.im>2022-12-13 15:38:37 +0100
committerFabian Meumertzheim <fabian@meumertzhe.im>2022-12-13 17:14:50 +0100
commit3053776429b1d5eb56ff85df8f0ccb61701d6f9f (patch)
treeebdc5b52183bff36eaf30bdbba0d0522fd1fae89 /CONTRIBUTING.md
parentc9aa340333982329928d428ed4cc717a77e20187 (diff)
downloadjazzer-api-3053776429b1d5eb56ff85df8f0ccb61701d6f9f.tar.gz
deploy: Host linked javadocs for all Maven artifacts
Getting clickable cross-references in Javadocs requires publishing the docs in order, which is documented in the new `CONTRIBUTING.md` guide.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b12a8266..8e69286d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -77,3 +77,17 @@ Requires an accounts on [Sonatype](https://issues.sonatype.org) with access to t
7. Log into https://oss.sonatype.org, select both staging repositories and "Close" them.
Wait and refresh, then select them again and "Release" them.
8. Locally, with Docker credentials available, run `docker/push_all.sh` to build and push the `cifuzz/jazzer` and `cifuzz/jazzer-autofuzz` Docker images.
+
+### Updating the hosted javadocs
+
+Javadocs are hosted at https://codeintelligencetesting.github.io/jazzer-docs, which is populated from https://github.com/CodeIntelligenceTesting/jazzer-docs.
+
+To update the docs after a release with API changes, follow these steps to get properly linked cross-references:
+
+1. Delete the contents of all subdirectories of `jazzer-docs`.
+2. Run `bazel build --//deploy:linked_javadoc //deploy:jazzer-api-docs` and unpack the jar into the `jazzer-api` subdirectory of `jazzer-docs`.
+3. Commit and push the changes, then wait for them to be published (can take a minute).
+4. Run `bazel build --//deploy:linked_javadoc //deploy:jazzer-docs` and unpack the jar into the `jazzer` subdirectory of `jazzer-docs`.
+5. Commit and push the changes, then wait for them to be published (can take a minute).
+6. Run `bazel build --//deploy:linked_javadoc //deploy:jazzer-junit-docs` and unpack the jar into the `jazzer-junit` subdirectory of `jazzer-docs`.
+7. Commit and push the changes, then wait for them to be published (can take a minute).