Skip to content

Commit 7c12187

Browse files
committed
chore: improve new module steps
1 parent 9a8b9bf commit 7c12187

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,11 @@ Run `mvn verify` to test, generate javadoc, and check style. If this passes loca
3030
1. Create a new `pom.xml` in the root of your new module. It must inherit from the parent POM, which implements the javadoc, testing, publishing, and other boilerplate. Be sure to add `<!--x-release-please-version -->` on the line specifying the module version, so our release tooling can update it (see sample pom below).
3131
1. Add the new package to `release-please-config.json`.
3232
1. Add the new module to the `<modules>...</modules>` section in the parent `pom.xml`.
33+
1. Add a `version.txt` file with a version matching that in your new `pom.xml`, e.g. `0.0.1`.
34+
2. If you care to release a pre 1.0.0 version, add the same version above to `.release-please-manifest.json`. Failing to do this will release a `1.0.0` initial release.
3335

3436
Sample pom.xml:
37+
3538
```xml
3639
<?xml version="1.0" encoding="UTF-8"?>
3740
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -43,6 +46,7 @@ Sample pom.xml:
4346
<version><!-- current parent pom version --></version>
4447
<relativePath>../../pom.xml</relativePath>
4548
</parent>
49+
<!-- The group id MUST start with dev.openfeature, or publishing will fail. OpenFeature has verified ownership of this (reversed) domain. -->
4650
<groupId>dev.openfeature.contrib.${providers | hooks | etc}</groupId>
4751
<artifactId>module</artifactId>
4852
<version>0.0.1</version> <!--x-release-please-version -->

0 commit comments

Comments
 (0)