jthambly/update-quarkus

GitHub Action workflow to update the Quarkus version

update-quarkus's Issues

Example classes are also added to project

Example code generated through the Quarkus Maven plugin is also added to the project.
Ideally, this should not occur.

Should automatically detect modified project files vs. Quarkus files

To fully support drop and go, it should compare what Quarkus files have been used in the past for when removing/diff/merging the file structure.

Need to collate a list of checksums going as far back as possible.

As checksums now exist, this is one step closer. #100

Need to collate a list of checksums going as far back as possible.

Originally posted by @jthambly in #13 (comment)

Verification of what happens when a branch already exists

A test case should be included that will cause a branch to exist prior, then try and do an update - ideally it should detect this and skip the update process.

Implement automatic verification tests

It would be ideal that CI verification is done with downloading and testing upgrades on Quarkus versions, both sequentially and by jumping multiple versions.

It could also be possible that this could be done when creating a GitHub Action #14

Fails when branch/request already exists

If a previous branch/pull request exists and has not been actioned yet it will fail.
Given by default, it checks once a week, if not previously actioned, it will fail weekly.

Error occurring at runtime.

An error occurred when running as the Action:

update-quarkus/action.yml

Line 128 in 522c883

find . -type f | xargs sha256sum > "../../working-copy/.update/$CURRENT_VERSION.sha256" && \

Action -> Generate checksums of latest base build
/home/runner/work/_temp/7bb8617a-ebaf-4eff-bda5-676229a8ef13.sh: line 7: ../../working-copy/.update/1.12.1.Final.sha256: No such file or directory
find: ‘standard output’: Broken pipe
find: write error
Error: Process completed with exit code 1.

Some test branches (used for verification) are listed with wrong version

update-quarkus/pom.xml

Line 18 in ec528d9

<quarkus.platform.version>1.11.5.Final</quarkus.platform.version>

There are instances of test branches that have been generated with an incorrect and later version.
I presume that this occurred through Quarkus Maven project generation.

It should not affect most verification tests, others will need to be carefully chosen.

User configuration for project files

Within the Action, there is a user-configurable section that should be migrated to the parent workflow. That is the project files to protect against replacement in the event that it cannot automatically determine which files are safe to delete.

PROJECT_FILES

Will need a way to determine if the checklist has loaded correctly.

Will need a way to determine if the checklist has loaded correctly.

Originally posted by @jthambly in #51 (comment)

Verification of what happens when trying to upgrade from a erroneous version

With the following versions, we cannot generate the source to determine which files should be removed.

1.10.0.Final
1.11.0.Final
1.11.1.Final

Although we might not be able to use the above versions for testing, automated testing should also test for instances where it needs to proceed with the backup method of updating project files.

This will not be done as apart of the GitHub Action work, instead it will be associated with issue #13

Need a way to verify the file system is as expected post update

For this to be achieved we will need a way to verify the filesystem post update.

Originally posted by @jthambly in #54 (comment)

Upon generating new pom.xml file, duplicates are created

When a new pom.xml is generated, duplicates exist.
This is due to additional extensions been added over the top of existing default ones.

The only way this can be fixed is to look up default entries and remove that from the extension list.

It will not break the build process, but it will warn about it.

Update fails indicating that it must use the extension(s)

Upon updating, an error is generated:

Failed to execute goal io.quarkus:quarkus-maven-plugin:2.0.1.Final:add-extension (default-cli) on project idp: Either the extension or extensions parameter must be set -> [Help 1]

Collect SHA256 checksums while testing

It may be useful to collect checksums of project files created during verification upgrades.

This may provide useful functionality down the track, and even perhaps in determining which files to delete when it cannot automatically determine this #13.

It may also be useful as another verification step that upgrades are generating these files as expected.

Verification tests pre-clean

If automatic testing fails, it may leave remnants of branches and pull requests.

It may be ideal to have a pre-clean to ensure that there are no leftover branches and PRs - only for test-related branches.

Tidying up duplicates has caused issues

When determining the duplicates, the duplicates were removed (#5) based on the prefix - this has caused issues.

Need to also sort checksum listings so it can easily be compared to down the track.

Need to also sort checksum listings so it can easily be compared to down the track.

Originally posted by @jthambly in #56 (comment)

Create a GitHub Action

As this work matures, it would be ideal to make it a GitHub action so that projects using this do not have to copy a long run of code.

Better removal of files if cannot detect quarkus files

If we are unable to determine pre-existing Quarkus files by means of re-generating the project files and taking checksums, then instead of removing anything that is not explicitly declared as a project file, we could generate a list of most likely Quarkus files.

Should automatically pull in extension list

To fully support drop and go, it should ideally pull out the existing extensions from the POM file.

Integrate functionality of quarkus-pom-action

Using XPath was not an option and hence a separate GitHub Action was created.

Although it may be messy, another way may be required in order to simplify the implementation by integrating this within our action instead.

User configuration option - Check List

The Action should be able to allow the user to specify the checklist in the parent workflow.
Need to migrate GIT_CHKLIST

Checksums are still been generated, even though they already existed

When generating a blank project, it should detect if a checksum already exists, If it does, it should skip that part.

It is not skipping.

Update fails under Quarkus 2.0.0

Due to changes in the usage of JUnit the update fails.

Cannot find a dependency matching 'io.quarkus:quarkus-junit5', maybe a typo

New project generations may produce different files

It has been observed #135 that checksums generated through the maven plugin may change?

Need to keep an eye on it.

The ability to work on alternate branches other than master/main

Given that manual workflows can be triggered on other branches, it would be wise that the update feature also is able to handle this. This also may be required when using a custom Action.