propactive/propactive-demo

A comprehensive demo project that uses the Proactive framework to validate and generate property values on runtime.

Propactive-demo

What are you looking at?

A comprehensive demo project that uses the Propactive framework to validate and generate property values on runtime.

It demonstrates the ability to:

• Create properties file using the JVM in a flexible manner.
• Control which properties files to generate.
• Plus validate property files on runtime with custom types.

The benefit of such approach is evident for enterprise microservices that rely on multiple properties, and deployed to different environments.

For further details, see: Propactive Framework's README

---

propactive-demo's Issues

Pipeline to upgrade demo's Propactive version on new releases

It would be desirable to keep the demo project up to date with the latest release version. We can enforce this by developing a callable workflow that can be triggered whenever a new Propactive release version is published.

Requirements:

• Since it takes time for the plugin portal and Maven central index to update. The pipeline should instead create a PR that will be run against the current CICD and then merge once the build is green.
  • This also gives us the opportunity to fix any breaking changes for major releases.
  • Or add any more features to demo within the project for minor releases.
  • Add a PR template that should be used for the type of pull requests.
• A ticket should also be raised for Propactive project itself to add a workflow step to call the version-bumper workflow for the demo project on a new version release.
  • It should be done via a rest call, see How to trigger a Github action with an HTTP request.
  • Restrict access to who can initiate the workflow. (should be token-based)

Add Gradle refreshVersions bot

Instead of manually updating the dependencies and their versions, it would be desirable to integrate the Gradle refreshVersions dependency within the CICD pipeline. For further details, please see: Gradle refreshVersions

Requirements:

• Add the refreshVersions dependency to the project.
  • Optional: you can use the organized dependency notations for popular libraries if you're feeling adventurous.
• Create a new manually triggered workflow named REFRESH_VRESIONS.yml to create a pull-request.
  • Run on ubuntu-20.04 image
  • It should checkout the branch.
  • Use a compatible Java version.
  • Runs ./gradlew refreshVersions
  • And then commit & pushes the modified versions.properties
  • ...Wait a second, a refresh versions bot exists and does just that
    • Please implement: RefreshVersionsBot
    • However, please amend the workflow file to be a manually triggered instead of a weekly dispatch trigger.

Please ensure that the build CI passes if you upgraded any dependencies (i.e. resolve any breaking changes if you want to upgrade any versions as part of this ticket)

Integrate with a Kotlin linter

It would be nice to have a linter to keep the project as consistent as possible. A widely popular Kotlin linter is Pinterest's ktlint. It has a built-in rule sets, formatter tasks, reporters, and allows extension with custom rule sets and reporters.

Requirements

• Set CI to run the linter after tests has passed. (must be a Makefile recipe)
• Provide an .editorconfig to allow IDE users adhere to the standards for a smoother dev experience.

Please see the user guide for further details.

Create a promote "Propactve" In project build.

or perhaps onboard dependabot to that for us.

Add `validateApplicationProperties` task

1.1.2 introduced a new task name: validateApplicationProperties

Requirements:

• Add task to CI workflow
• Create a failing branch to demo how it error's out.

Make project Hacktoberfest-ready

Prepare your project for contributions by following these best practices:

• Add the “hacktoberfest” topic to your repository to OPT-IN TO HACKTOBERFEST and indicate you’re looking for contributions.
• Apply the “hacktoberfest” label to issues you want contributors to help with in your GitHub or GitLab project.
• Add a CONTRIBUTING.md file with contribution guidelines to your repository.
• Choose issues that have a well-defined scope and are self-contained.
• Adopt a code of conduct to create a greater sense of inclusion and community for contributors.
• Be ready to review pull/merge requests, accepting those that are valid by merging them, leaving an overall approving review, or by adding the “hacktoberfest-accepted” label.
• Reject any spammy requests you receive by labeling them as “spam,” and any other invalid contributions by closing them or labeling them as “invalid.”

For further details, see: https://hacktoberfest.com/participation/#maintainers

Improve Propactive-demo documentation

README.md

• Expand documentation to be more comprehensive/detailed.

CONTRIBUTING.md

• Document that IDEA users can use the task ktlintApplyToIdea to adhere to our coding standards.

Remake CD build summary output.

The current build summary for each environment image run is clattered and has lots of unnecessary duplication (i.e. the "What are you looking at?" section can just be part of the README.md and you can redirect people there...)

Remake the generated properties file values display as an easy to read/view/compare markdown table while guiding users to where they can download each environment artifacts (i.e. links for downloads of application.properties an generated image...)

Please use a builder pattern for generating the markdown table in the propactive-demo project...