Adding pom metadata required for mvn site:stage. Adding release instructions to readme

josemduarte · josemduarte · commit 93fe015ab9c6 · 2025-01-07T16:03:04.000-08:00
diff --git a/README.md b/README.md
@@ -35,6 +35,16 @@ If you are using Maven you can add the BioJava repository by adding the followin
     </dependencies>
 ```
 
+### For developers
+
+Release biojava to maven central:
+- `mvn -Prelease release:prepare`
+- `mvn -Prelease release:perform`
+Publish new javadocs:
+- `mvn site` this will write `target/site`, but that's not enough for a multimodule project. See [docs](https://maven.apache.org/plugins/maven-site-plugin/examples/multimodule.html)
+- `mvn site:stage` this will write the full html directory tree to `target/staging`
+- Push the contents of `target/staging` to the [biojava.github.io repo](https://github.com/biojava/biojava.github.io) under directory `docs/api` for it to be published in biojava.org
+
 ### Mailing Lists
 
 BioJava has one main mailing list. In order to avoid SPAM the list only accepts postings from list members. Anybody can become a list member, so please subscribe before you post. If you send without being subscribed your mail might get stuck in the moderation loop, which can cause several weeks of delay (no fun to read through all that spam).
diff --git a/pom.xml b/pom.xml
@@ -534,6 +534,13 @@
 			<id>ossrh</id>
 			<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
 		</repository>
+		<site>
+			<!-- Needed for site plugin, to do mvn site:stage (without which a multimodule project won't have all the correct directory structure)
+			     Note that the values here are not actually used for deployment (for that we'd need some sort of proper git+ssh url I guess) - JD 2024-01-07 -->
+			<id>deploy</id>
+			<name>biojava.org</name>
+			<url>git:github.com:biojava/biojava.github.io.git</url>
+		</site>
 	</distributionManagement>
 
 	<profiles>
