Skip to content

Commit

Permalink
Merge pull request #626 from jonathannewman/maint/main/add-learnings
Browse files Browse the repository at this point in the history
(maint) update README with learnings about composite project behavior
  • Loading branch information
steveax authored Feb 20, 2024
2 parents f8e19d3 + c5bb616 commit 7f05baa
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,24 @@ Note that the symble `:ezbake` is not strictly necessary here.
Composite EZBake projects usually do not define their own services but rather
provide a list of dependencies which themselves define TK services. Because of
this it is not strictly necessary to define a profile such as `:ezbake` shown
above; although it is conceivable that such a composite project may define its
own services, it is unlikely and ill-advised because no one likes blurred lines
in architectural diagrams. Just look at the Leaning Tower of Pisa.
above.

If the composite project needs to define build time templates, such as `resources/ext/cli_defaults/cli-defaults.sh.erb`
EZbake will only include items that are in jars on the class path at the time
the project is staged. As a result, the project must include a self-referential dependency
in the `ezbake` profile. This will allow ezbake to discover these files correctly.
```clojure
(def my-project-version "0.0.1-SNAPSHOT")

(defproject somenamespace/myproject my-project-version
...
:profiles {
...
:ezbake {:dependencies [[mynamespace/myproject ~my-project-version]]}
...
}
)
```

#### Additional Uberjars

Expand Down

0 comments on commit 7f05baa

Please sign in to comment.