Commit Graph

379 Commits

Author SHA1 Message Date
Thilo Schwarz 4eb923ebee Update README.md
Signed-off-by: Thilo Schwarz <th-schwarz@users.noreply.github.com>
2025-03-30 12:56:15 +02:00
Thilo Schwarz efd7f2228d Update README.md
Signed-off-by: Thilo Schwarz <th-schwarz@users.noreply.github.com>
2025-03-30 12:54:40 +02:00
thischwa fd997bf6da Add Maven repository and usage instructions to README
Updated the README to include instructions for integrating the project into a Maven-based setup, like adding the repository and dependency configurations. These changes assist developers in easily utilizing the library.
2025-03-30 12:51:56 +02:00
thischwa 1a1794ff37 Refactor Maven pom.xml for SCM and distribution setup.
Reorganized the `scm` block and added a `distributionManagement` section for publishing to GitHub Maven Packages. Cleaned up unused plugin configurations and improved XML formatting for better readability.
2025-03-27 19:08:26 +01:00
thischwa 0bc1cef900 Fix README badge formatting for GitHub release link
Updated the README to correctly format the GitHub release badge and its hyperlink. This enhances clarity and ensures the badge integrates seamlessly with the text.
2025-03-24 19:06:28 +01:00
thischwa 2c9faf882e [maven-release-plugin] prepare for next development iteration 2025-03-24 18:47:49 +01:00
thischwa 27b7048f97 [maven-release-plugin] prepare release v0.1.0-beta.1 2025-03-24 18:47:46 +01:00
thischwa 9dd7489803 Update version to 0.1.0-SNAPSHOT in pom.xml
Reverted the version from 0.1.1-SNAPSHOT to 0.1.0-SNAPSHOT for alignment with the development lifecycle. Ensures consistency with planned versioning strategy.
2025-03-24 18:42:25 +01:00
thischwa 006fb783e5 [maven-release-plugin] prepare for next development iteration 2025-03-24 18:26:15 +01:00
thischwa 9b5d791f9e [maven-release-plugin] prepare release v0.1.0 2025-03-24 18:26:11 +01:00
thischwa be7f1798bf Refactor javadoc plugin into a Maven profile.
Moved javadoc configuration and execution into a dedicated profile to improve build configuration modularity. This change ensures the javadoc generation is optional and can be controlled via the `javadoc` profile activation.
2025-03-24 18:24:22 +01:00
thischwa 4f835a22ef Add skipTests argument to Maven release plugin
This update configures the Maven release plugin to include the `-DskipTests` argument. It ensures tests are skipped during release processes, speeding up build times for releases.
2025-03-24 18:10:40 +01:00
thischwa 08a5606da6 reduce code smells 2025-03-24 15:49:43 +01:00
thischwa d8726e5e64 Add SonarCloud badges to README
Added badges for quality gate status, security rating, coverage, lines of code, and code smells from SonarCloud. These provide better visibility into the project's code quality and metrics directly from the README.
2025-03-24 15:44:03 +01:00
thischwa e77b392ffd Update workflow to rename job and fix Sonar project key
Renamed the `mvn-test` job to `mvn-sonar` for better clarity and alignment with its purpose. Additionally, corrected a typo in the Sonar project key to ensure accurate project identification.
2025-03-24 15:23:47 +01:00
thischwa ae14436b08 Simplify and merge Maven build and SonarCloud scan steps
Consolidated the Maven build and SonarCloud analysis into a single step for efficiency. Removed redundant workflow definitions and ensured proper environment variable handling. This change reduces complexity and streamlines the CI/CD workflow.
2025-03-24 15:07:12 +01:00
thischwa 5c1e7fe86d Add SonarCloud scan to CI workflow
Introduce a new job in the GitHub Actions workflow to integrate SonarCloud analysis. This includes setting up JDK 17, caching Maven dependencies, and running the SonarCloud Maven plugin for code quality checks.
2025-03-24 14:51:32 +01:00
thischwa efac34e73c Add SonarCloud and JaCoCo integration to pom.xml
Configured SonarCloud properties for code analysis and reporting. Integrated JaCoCo Maven plugin to generate code coverage reports in XML format for SonarCloud. These changes enhance code quality metrics and monitoring.
2025-03-24 10:07:21 +01:00
thischwa 3cd29e4e91 Add release badge to README 2025-03-24 10:00:54 +01:00
thischwa da661e7cd0 Add release badge to README
Included a GitHub release badge to display the latest release version directly in the README. This improves visibility of the project's current state and provides quick access to the release details.
2025-03-23 20:06:07 +01:00
thischwa fa5840999d Update Javadoc and example code for CfDnsClient
Regenerated all Javadoc files with updated timestamps and fixed an example snippet in `CfDnsClient` for consistent variable naming. This ensures updated documentation and code clarity.
2025-03-23 19:04:50 +01:00
thischwa 513d89f017 Update .gitignore and add jQuery UI overrides CSS
Added an entry for a javadoc script path in .gitignore to exclude it from version control. Also, introduced a custom CSS file to override specific styles in jQuery UI, primarily adjusting active state colors and borders.
2025-03-23 18:44:26 +01:00
thischwa e415dc1106 Refactor HTTP request methods and update Javadoc language.
Refactored HTTP request methods by removing explicit `responseType` parameters where possible and adjusting to specific response mapping needs. Additionally, updated Javadoc documentation language from German to English for consistency, improving clarity and accessibility.
2025-03-23 18:39:36 +01:00
thischwa af757714f4 Update README with corrected javadoc link
Replaced the broken relative javadoc link with a working absolute URL pointing to the hosted documentation. This ensures easier access to the API reference for users.
2025-03-23 13:18:08 +01:00
thischwa 6e05348f6a Remove obsolete javadoc.sh script
The javadoc.sh script was specific to a local environment and is no longer needed. Removing it ensures cleaner code and avoids confusion or potential misuse.
2025-03-23 13:13:49 +01:00
thischwa 30ffb7c4b4 Add Javadoc generation scripts and enhance README examples
Introduce Javadoc-related files (`javadoc.sh`, `options`, and `packages`) for API documentation generation. Update README to improve clarity on usage examples and remove redundant "Example" headings for a cleaner presentation.
2025-03-23 13:12:45 +01:00
thischwa 042678a6d7 Add usage examples for CfDnsClient in API documentation
Expanded the API documentation by including practical examples for the `CfDnsClient` class. Updated Javadoc metadata and modified the index.html title for better context.
2025-03-23 13:11:27 +01:00
thischwa a443c0feae Add initial documentation homepage 2025-03-23 12:36:14 +01:00
thischwa c39e022e41 Initial commit 2025-03-23 12:12:53 +01:00