corgibytes / freshli-agent-java Goto Github PK

See https://ktlint.github.io/ for documentation on installing and using ktlint.

• Add install instructions to README.md
• Add ktlint to bin/lint.rb
• Add ktlint to bin/format.rb
• Fix all issues that are identified by ktlint

By using jlink to create a custom JRE and embedding it into the executable, we won't need to ship the JRE in the production Docker image for freshli. And that should result in smaller builds.

Docs: https://badass-runtime-plugin.beryx.org/releases/latest/

• Add build task for generating custom runtime image with jlink
• Update README.md with instructions for running the new task
• Update acceptance test suite to run against the binary as built with jlink. (This is needed to confirm that we included the correct parts of the JRE. If we've missed anything then we should get runtime errors when those tests execute.)

It can be difficult to determine if specific changes are included in the executable that someone has installed. To help with that difficulty, we need to add versions.

This should just output the application's version without any other information.

This is a command that can be used to provide a list of packages for which the agent is able to retrieve their history by calling the retrieve-release-history command.

It can be difficult to determine if specific changes are included in the executable that someone has installed. To help with that difficulty, we need to add versions.

Versions should be incremented each time the main branch is updated. A matching Git tag should be created each time a version is created. The dependency-history-maven repository provides a good example of this in action. Note that dependency-history-maven is being deployed to Maven Central, but we don't want to publish this program there.

We need to make sure that the application can be built, tested, and run on Windows. This is going to require some changes because various assumptions have been made that are not platform independent. Not the least of which is the OS file separator character (\ on Windows, but / on macOS and Linux). There are likely other issues as well.

retrieve-release-history

Used to get the release history for a specific package.

freshli-agent-java retrieve-release-history --list-valid-purls | package-url

What this command does?

Queries Maven repositories for the list of releases for a specific package. Lists each release version and the date it was released in a tabular format. The full package release history will be provided in the output regardless of the version that is specified in the package-url parameter.

Command Options:

• --list-valid-purls
  Outputs pkg:maven, which is the only PURL type that this command supports. This option is used by other commands that need to figure out which Package URLs this command supports.
• package-url
  A valid Package URL. The specified package's release history will be displayed in the command's output. If the package-url does not start with pkg:maven then this command will display an error.

To enable the use of the freshli CLI cache, the path to that cache needs to be provided as a global parameter, similar to how it is specified for the freshli executable. This location needs to be then provided to the dependency-history-maven project once it's support for caching to SQLite databases has been built (see corgibytes/dependency-history-maven#24). The caching support in dependency-history-maven will be configured to write to a table named AgentJavaHttpCache.