Skip to content

Commit

Permalink
Tweak readme (#189)
Browse files Browse the repository at this point in the history
  • Loading branch information
simontoens authored Jan 13, 2025
1 parent 7e9b63a commit c18f67c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ Pomgen uses the lockfiles generated by [rules_jvm_external](https://github.com/b
- pomgen >= 2.0.0 is compatible with rules_jvm_external >= 5.0


## Setup
## Setup 101

- Add a `java_library` rule to your Bazel Package as the [default target](https://bazel.build/concepts/labels) (the target has same name as its Bazel Package, ie the directory the BUILD file lives in)
- For each Maven Artifact producing Bazel Package, a [BUILD.pom](examples/hello-world/healthyfoods/fruit-api/MVN-INF/BUILD.pom) file defines Maven specific metadata
- A special [marker file](examples/hello-world/healthyfoods/MVN-INF/LIBRARY.root) groups one or more Maven Artifacts into a Library
- Add a `java_library` rule that builds the jar, make it the [default target](https://bazel.build/concepts/labels) (or [configure](docs/mdfiles.md#maven_artifacttarget_name) the target name)
- Add a [MVN-INF/BUILD.pom](examples/hello-world/healthyfoods/fruit-api/MVN-INF/BUILD.pom) file to define Maven specific metadata (artifactId etc)
- Add a [MVN-INF/LIBRARY.root](examples/hello-world/healthyfoods/MVN-INF/LIBRARY.root) file to mark the Bazel Package as a library with a single jar artifact

See [this doc](docs/mdfiles.md) for more information on pomgen files.
See [this doc](docs/mdfiles.md) for more information on pomgen metadata files.


## Bazel Package References

The BUILD file of a Maven Artifact producing Bazel Package may obviously reference other Bazel Packages in the repository. pomgen will follow these references and generate pom.xmls for all referenced Bazel Packages.
The BUILD file of a Maven Artifact producing Bazel Package may obviously reference other Bazel Packages in the repository. pomgen will follow these references and generate pom.xml files for all referenced Bazel Packages.


## Change Detection
Expand Down

0 comments on commit c18f67c

Please sign in to comment.