u-ways / kotlin-quarkus-realworld-example-app Goto Github PK

The project currently runs on Java 11, however the latest LTS is Java 21. Therefore it would be nice to run this realworld example on the latest Java LTS. The requirements are:

• Upgrade Kotlin version to latest stable release that supports 21 (1.9.20)
• Upgrade Gradle JVM target to 21. (Which means upgrade Gradle to 8.4)
• Upgrade Docker files to use Java 21 openjdk.
• Upgrade CI pipeline to build and test the project to Java 21.
• Fix any breaking changes due to the JVM upgrade.

When a new contributor works on a CICD ticket that requires new write permission to the workflow it seems that the job fails with the error:

"Resource not accessible by integration"

See: https://github.com/u-ways/kotlin-quarkus-realworld-example-app/actions/runs/3174636971

This issue seems to be a common one and is referenced in here: actions/first-interaction#10

This happens as soon as the person creating the PR does not have permission to the repository.

One possible solution is to use a bot to run the actions that should have the right permissions. See: Boring Cyborg

Is there an easier fix or should we implement that?

The CICD pipeline runs whenever any changes are pushed...

It would be desirable to set the CICD pipeline to ignore non-sourcecode changes. This is possible using the excluding path workflow syntax. However, it would a "deny all, permit few" approach would be better/safer, see: Including paths workflow syntax

Setup GitHub Actions Continuous Integration to run our linter and all of our tests on commit. For more information, please see: GitHub docs - Quickstart for GitHub Actions

CI requirements

• Runs on ubuntu-20.04 image
• Uses GH actions Java 11
• It should run all tests and fails build for any red (failing) tests.

Extra if you're looking for a harder challenge (otherwise I will raise this as a separate issue)

• Upload test artifacts regardless if the test succeeded or failed
• Use dorny's test-reporter to displays test results from directly in GitHub

Please update your Kotlin version

https://youtrack.jetbrains.com/issue/KT-45566/JDK-16-e-javalangNoClassDefFoundError-Could-not-initialize-class-orgjetbrainskotlincomintellijpomjavaLanguageLevel#focus=Comments-27-4781545.0-0

I had the same error

Add another job with the name Test-Reporter within the build.yml to do the following:

• Downloads the output of the build job (See actions/download-artifact)
• Use dorny's test-reporter to displays test results from directly in GitHub

This job should only run after the build job. See: Worflow syntax - needs.

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.

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

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)