1
- = tools.project
1
+ image:https://img.shields.io/github/license/lazy-cat-io/tools.project[license,link=license]
2
+ image:https://img.shields.io/github/v/release/lazy-cat-io/tools.project.svg)[https://github.com/lazy-cat-io/tools.project/releases]
3
+ image:https://github.com/lazy-cat-io/tools.project/actions/workflows/build.yaml/badge.svg[https://github.com/lazy-cat-io/tools.project/actions/workflows/build.yml]
4
+
5
+ image:https://img.shields.io/clojars/v/io.lazy-cat/tools.project.svg[clojars,link=https://clojars.org/io.lazy-cat/tools.project]
6
+
7
+ == tools.project
2
8
3
9
A project management tool.
4
10
5
11
**Status**: alpha
6
12
7
- == Features
13
+ === Features
8
14
9
15
- Unify a project manifest
10
16
- Collect dynamic metadata of builds at compile time (e.g. uberjar step) and use the metadata at runtime
11
17
- Transform a project manifest to https://github.com/seancorfield/build-clj[io.github.seancorfield/build-clj] format
12
18
- Manage project version
13
19
14
- == Roadmap
15
-
16
- - [ ] Stabilize the API
17
- - [ ] Add validation using `malli` schemas
18
- - [ ] Use `rewrite-edn` to preserve the manifest formatting style
19
- - [ ] Add versioning support for `semver`, `git flow`
20
- - [ ] Add usage examples with the babashka and Clojure CLI as tool `(-T)`
21
- - [ ] Add support for `mono repositories`
22
-
23
- == Getting started
20
+ === Getting started
24
21
25
- === Installation
22
+ ==== Installation
26
23
27
24
Add the following dependency in your project:
28
25
@@ -38,7 +35,7 @@ Add the following dependency in your project:
38
35
io.lazy-cat/tools.project {:mvn/version "N/A"}
39
36
----
40
37
41
- === Configuration
38
+ ==== Configuration
42
39
43
40
Add the project manifest to the project root directory.
44
41
@@ -233,6 +230,15 @@ How to add `BUILD_NUMBER` on GitHub Actions:
233
230
echo 'BUILD_NUMBER=${{ github.run_number }}' >> $GITHUB_ENV;
234
231
----
235
232
236
- == License
233
+ === Roadmap
234
+
235
+ - [ ] Stabilize the API
236
+ - [ ] Add validation using `malli` schemas
237
+ - [ ] Use `rewrite-edn` to preserve the manifest formatting style
238
+ - [ ] Add versioning support for `semver`, `git flow`
239
+ - [ ] Add usage examples with the babashka and Clojure CLI as tool `(-T)`
240
+ - [ ] Add support for `mono repositories`
241
+
242
+ === License
237
243
238
244
link:license[Copyright © 2022 lazy-cat.io]
0 commit comments