added a cool new readme.md to inform user
All checks were successful
Maven Build / build (push) Successful in 10m19s

This commit is contained in:
2025-05-22 16:15:20 +02:00
parent 1e5f532fe1
commit 4baa9eea93

72
readme.md Normal file
View File

@@ -0,0 +1,72 @@
# Pommer Testing Repository Maven/Kotlin
This is a **testing repository** used to validate the output of [`pommer.py`](https://gitea.example.com/rattatwinko/pommer), a CI workflow generator for Java/Kotlin projects.
> ⚠️ **Internal Use Only**
> This repository and the `pommer` tool are intended solely for internal testing within Gitea. Do not distribute or share externally.
---
## Purpose
This repository is part of the **Pommer testing suite**, specifically for verifying:
* Maven-based builds
* Kotlin source code handling
* CI workflow generation compatibility
This project is structured using **Kotlin + Maven** (via `pom.xml`) and serves as a fixture for validating Pommer's behavior with these technologies.
> There is a **separate testing repo** for **Java/Gradle** combinations.
---
## What This Repo Contains
* A simple Kotlin project using **Maven** (`pom.xml`)
* CI workflow (`.gitea/workflows/build.yaml`) generated by the latest `pommer.py`
* A `build.sh` script for local build verification
* No production code — just scaffolding for test purposes
---
## How to Use
To generate a new workflow and build script using `pommer.py`:
```bash
python3 /path/to/pommer.py --dir . # Can also be in this repo!
```
This will:
* Detect the `pom.xml` and Kotlin files
* Parse project metadata
* Generate:
* `.gitea/workflows/build.yaml`
* `build.sh`
Use these files to verify that CI and local build behavior work correctly under various changes to the Pommer tool.
---
## Notes
* This project uses IntelliJs default Kotlin/Maven template.
* You may wipe and regenerate the workflow and build files as needed when testing new versions of Pommer.
* Feel free to introduce new edge cases, multi-module setups, or config tweaks to test Pommer robustness.
---
## Related Projects
* `pommer` main repo The actual tool being tested
* `gradletest` Sister repo for Java/Gradle combinations
---
## Support
Reach out to **rattatwinko** for any issues related to Pommer testing or feedback on workflow generation.