Skip to content

Commit fd101c5

Browse files
Post first release update
1 parent e9a0136 commit fd101c5

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,20 @@ A lightweight Java library for printing directory structures in a clean, tree-li
2525
* [Contributing & Contact](#contributing--contact)
2626

2727
# Import dependency
28-
> [!IMPORTANT]
29-
> Soon 😉
28+
For Maven, import this dependency to your `pom.xml`:
29+
30+
```xml
31+
<dependency>
32+
<groupId>io.github.computerdaddyguy</groupId>
33+
<artifactId>jfiletreeprettyprinter</artifactId>
34+
<version>0.0.1</version>
35+
</dependency>
36+
```
37+
38+
For Gradle:
39+
```
40+
implementation "io.github.computerdaddyguy:jfiletreeprettyprinter:0.0.1"
41+
```
3042

3143
# Usage
3244
```java

release_process.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# JFileTreePrettyPrinter release flow
2+
3+
- **In `develop` branch:**
4+
- Run tests
5+
- Ensure `develop` branch is [Sonar-ready](https://sonarcloud.io/summary/new_code?id=ComputerDaddyGuy_JFileTreePrettyPrinter&branch=develop)
6+
7+
- **Merge `develop` into `main` branch**
8+
9+
- **In `main` branch:**
10+
- Update `pom.xml` to remove `-SNAPSHOT` version (keep only `X.Y.Z`)
11+
- Update `README.md` (with new `X.Y.Z` dependency version)
12+
- Update `CHANGELOG.md` with changes
13+
- Update `ROADMAP.md` if necessary
14+
- Commit locally
15+
- Tag with appropriate `vX.Y.Z`
16+
- Push code & tags
17+
18+
- **In Github:**
19+
- Create new release based on tag: copy content of `CHANGELOG.md` for this version
20+
- Github `release` workflow will run automatically
21+
- Few minutes later, artifact is available on Maven Central 🎉
22+
23+
- **Merge `main` back into `develop` branch**

0 commit comments

Comments
 (0)