Self update - Githubissues

exasol / project-keeper

This maven plugin checks and unifies a project's structure according to the Exasol integration team's repository standards.

MIT License

3 stars 1 forks source link

Self update #140

Closed jakobbraun closed 2 years ago

jakobbraun commented 3 years ago

Add a feature to project keeper to update itself to the latest available version.

ckunki commented 2 years ago

This will probably require an additional dependency to

<dependency>
    <groupId>org.kohsuke</groupId>
    <artifactId>github-api</artifactId>
    <version>1.307</version>
</dependency>

Compare implementation in release-droid:

GitHubGateway method getLatestTag()
GitHubGateway method createGHRepository()
class GitHubConnectorImpl

This suggests to think about a shared library providing github connectivity and related services.

One step ahead the question arises, where to store the github credentials:

a) reuse the file currently used by release-droid: ~/.release-droid/credentials
b) define a new file for project-keeper , eg. ~/.project-keeper/credentials
c) define a file to be used by multiple apps in the domain of exasol product integration tools, eg. ~/.exasol-pi-tools/credentials

ckunki commented 2 years ago

The last comment was based on wrong assumptions -- please ignore. To check if a newer version is available Project-keeper needs to look into maven repository.

There are multiple alternatives to do so

maven API
- MavenMetadataSource.retrieveAvailableVersions( MetadataResolutionRequest request)
- new DefaultArtifactFactory()
- DefaultArtifact
pure http(s) requests
- stackoverflow/11658087
- Sample for access via Plexus
Maven repo REST API
- http://search.maven.org/#api
- example for project-keeper using json and including information about latest version in response/docs[0]/latestVersion: https://search.maven.org/solrsearch/select?q=g:com.exasol+AND+a:project-keeper-cli&wt=json

ckunki commented 2 years ago

Open questions regarding requirements:

Should version check be optional (since it requires network access) or mandatory? Proposal by @kaklakariada: project-keeper verify phase should be successful, even if pk version is outdated. Rationale: Releasing a new version of project keeper should not break existing projects or builds.
If user's pom file does not use pk as a maven plugin, should pk rate this as an error?
How do CLI users of project-keeper download, install and update project-keeper? Background: update of maven plugin seems to be straight forward.