diff --git a/logo.png b/logo.png new file mode 100644 index 0000000..7898be7 Binary files /dev/null and b/logo.png differ diff --git a/readme.md b/readme.md index fcd52bc..bdc41b9 100644 --- a/readme.md +++ b/readme.md @@ -1,29 +1,35 @@ -# Pommer 🍟 +
+ logo image +
-**Pommer** is an internal Python tool designed to streamline CI workflow generation for Java/Kotlin Maven projects. It scans for `pom.xml` files, analyzes project metadata, and generates a Gitea CI workflow along with a local build script. +--- +**Pommer** is an internal Python tool designed to streamline **CI workflow generation for Java/Kotlin projects** using **Maven**. It scans your project for `pom.xml` files, analyzes project metadata, and generates a Gitea CI workflow along with a local build script for convenience. + +> βš™οΈ **This is the stable, Maven-only branch.** +> For Gradle support, switch to the `master` branch. --- ## ⚠️ Internal Use Only -> **This tool is for internal use within Gitea only. Do not distribute or share to outsiders.** +> **This tool is for internal use within the local Gitea Instance only. Do not distribute or share externally.** --- ## Features -- **Automatic discovery** of all `pom.xml` files in a repository. -- **Parses project metadata** (artifactId, groupId, version, Java/Kotlin detection, etc.). -- **Generates a Gitea CI workflow** compatible with multi-module Maven projects. -- **Creates a local `build.sh` script** for convenience. -- **Configurable**: Target a specific directory or POM file. +* πŸ” **Automatic discovery** of Maven projects (`pom.xml`) +* πŸ“¦ **Parses project metadata** (artifact ID, group ID, version, Java/Kotlin usage, etc.) +* πŸ—οΈ **Generates a Gitea CI workflow**, compatible with multi-module Maven setups +* πŸ§ͺ **Creates a `build.sh` script** for local Maven testing +* 🎯 **Configurable**: Target a specific directory or file --- ## Usage -No installation required. Run directly with Python 3. +No installation required. Just run with Python 3: ```bash python3 pommer.py @@ -31,18 +37,21 @@ python3 pommer.py ### Options -| Option | Description | -|------------------------|-------------------------------------------------------------| -| `-d`, `--dir` | Base directory to scan for `pom.xml` files (default: `.`) | -| `-p`, `--specific-pom` | Path to a specific `pom.xml` file to process | +| Option | Description | +| ---------------------- | ------------------------------------- | +| `-d`, `--dir` | Base directory to scan (default: `.`) | +| `-p`, `--specific-pom` | Path to a specific `pom.xml` file | #### Examples -- Scan a specific directory: +* Scan a specific directory: + ```bash python3 pommer.py --dir path/to/project ``` -- Use a specific POM file: + +* Use a specific POM file: + ```bash python3 pommer.py --specific-pom path/to/pom.xml ``` @@ -51,45 +60,52 @@ python3 pommer.py ## Output -- **Gitea Workflow:** - `.gitea/workflows/maven_build.yaml` +* πŸ“„ **Gitea Workflow:** + `.gitea/workflows/build.yaml` Automates build and artifact upload for all detected Maven projects. -- **Build Script:** - `build.sh` - Simple script for local Maven builds. +* πŸ”§ **Build Script:** + `build.sh` + Local script to build all Maven projects easily. -![](img.png) +--- -### _**Comment on Compile Times with CI/CD :**_ +## ⚑ CI/CD Compile Time Notice -_Currently installing **JDK** and finishing up the **Proccess** takes ages! If it is **stuck** on **"Downloading JDK 21"** for a few minutes just **wait**. If you arent sure if its actually doing stuff ; **check the Network Usage of the Server**. If it is **0** for a long time then **restart the Runner!** Finishing up also takes ages ; but that **usually doesn't get stuck** as often. But if just **reboot**!_ - -_**For big Projects it might take a while** ; if compiling via Maven on your local Instance takes ages ; **it will take even longer on Gitea CI/CD!**_ +> ⚠️ **Slow compile or stuck builds?** +> +> * **Installing JDK** and setting up the runner can take time. +> * If it’s stuck on **"Downloading JDK 21"**, be patient and **check network usage**. +> * **No activity?** β†’ Restart the runner. +> * Final build steps are **slow but usually fine**. +> * **Local builds slow?** β†’ Expect slower CI/CD times. --- ## Requirements -- Python 3.7+ -- Only standard Python libraries required +* Python 3.7+ +* No third-party dependencies (standard library only) --- ## Notes -- The workflow uses the highest Java version detected among all modules. -- Kotlin support is detected automatically. -- For internal CI/CD use only. +* This branch **only supports Maven**. +* For Gradle support, use the `gradle-support` branch. +* Java/Kotlin usage is detected automatically. +* The workflow uses the **highest JDK version** found. --- ## Support -For questions or issues, contact [Internal Team/Contact Person]. +Contact **rattatwinko** for help or feature requests. --- ## License -**Internal Use Only – Not for Distribution** \ No newline at end of file +**Internal Use Only – Not for Distribution** + +More details are in pommer.py \ No newline at end of file