Skip to content

Commit c98332d

Browse files
committed
docs(readme): Add README
1 parent b84299f commit c98332d

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

README.adoc

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
= java-service-archetype
2+
3+
Maven archetype that generates a structured multi-module Java service project.
4+
You describe your integrations, service areas, and presentation architectural tiers at generation time;
5+
the archetype builds the full module tree and wires up the parent POM.
6+
7+
== Generate a Project
8+
9+
[source,bash]
10+
----
11+
./mvnw archetype:generate \
12+
-DarchetypeGroupId=io.github.jeffjensen \
13+
-DarchetypeArtifactId=java-service-archetype \
14+
-DarchetypeVersion=1.0.0-SNAPSHOT
15+
----
16+
17+
See the https://jeffjensen.github.io/java-service-archetype/[project site] for the full prompts reference, module structure, examples, and build instructions.
18+
19+
== CI / CD
20+
21+
Three GitHub Actions workflows are included.
22+
23+
=== Build any branch (`build-any-branch.yml`)
24+
25+
Runs `./mvnw clean verify` on every push and pull request.
26+
Pushes to `main` automatically trigger the snapshot deploy and site publish workflows.
27+
Documentation-only changes (`.adoc`, `.md`, `src/site/**`) are skipped.
28+
29+
=== Deploy snapshot (`deploy-snapshot.yml`)
30+
31+
Triggered when the build workflow succeeds on `main`.
32+
Publishes a `-SNAPSHOT` artifact to Maven Central (Sonatype).
33+
Release versions (without `-SNAPSHOT`) are skipped automatically.
34+
35+
Required repository secrets:
36+
37+
[cols="1,2"]
38+
|===
39+
|Secret |Description
40+
41+
|`CENTRAL_USERNAME` |Maven Central portal username
42+
|`CENTRAL_TOKEN` |Maven Central portal token
43+
|===
44+
45+
=== Publish site (`publish-docs.yml`)
46+
47+
Triggered when the build workflow succeeds on `main`, or manually via `workflow_dispatch`.
48+
Runs `./mvnw site` and publishes the Maven site to GitHub Pages.
49+
50+
Enable GitHub Pages (repository Settings → Pages → Source: *GitHub Actions*) before the first run.

0 commit comments

Comments
 (0)