Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify process of making releases #582

Merged
merged 5 commits into from
Jan 14, 2025
Merged

Simplify process of making releases #582

merged 5 commits into from
Jan 14, 2025

Conversation

Sophietje
Copy link
Collaborator

@Sophietje Sophietje commented Dec 18, 2024

This PR adds a Github workflow for (1) drafting a release, and (2) uploading Docker images to the registry.

This will modify the way that we're currently making releases. I envision the following workflow:

  1. User makes commit to prepare for the version release, changing the versions where needed (same as current first step)
  2. User triggers Github Action via Github's interface, you will be asked to provide the new version (X.Y.Z) as input
  3. Draft release is made by workflow (1)
  4. When ready, user inspects the draft release made by the workflow. The user can make changes if necessary and 'publishes' it definitively
  5. Docker images are made and uploaded by workflow (2)
  6. User makes commit for next SNAPSHOT version (the same as current 7th step)
  7. Inform the world

Fixes #490

@Sophietje
Copy link
Collaborator Author

TODO: Fix upload of JARs to release, it currently cannot find the right files

@Sophietje Sophietje changed the title WIP: Simplify process of making releases Simplify process of making releases Jan 7, 2025
@Sophietje Sophietje requested a review from bnouwt January 7, 2025 10:23
@bnouwt
Copy link
Collaborator

bnouwt commented Jan 10, 2025

Thanks @Sophietje! This change is very helpful and allows us to release new versions more often 👍

Some general remarks:

  • I do find it a pity that these CI/CD solutions are specific to GitHub and are not portable to other platforms (although I do not think we will move any time soon 😄 ). I would typically prefer using Maven plugins like (maven-release-plugin, maven-docker-plugin, ...) as much as possible, but maybe that is no longer best practise.
  • Currently, the version of the master is 1.2.6-SNAPSHOT, but we discussed the new version we want to release next week will have version 1.3.0. It feels a bit strange that despite there being version 1.2.6-SNAPSHOT there will never be an actual version 1.2.6. Is that a problem?

I've finished my review and added some comments here and there. Nothing blocking, so I think we are ready to merge.

Copy link
Collaborator

@bnouwt bnouwt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finished reviewing 👍

.github/workflows/docker-image-release.yml Outdated Show resolved Hide resolved
.github/workflows/draft-release.yml Show resolved Hide resolved
.github/workflows/draft-release.yml Show resolved Hide resolved
README.md Show resolved Hide resolved
@Sophietje
Copy link
Collaborator Author

  • I do find it a pity that these CI/CD solutions are specific to GitHub and are not portable to other platforms (although I do not think we will move any time soon 😄 ). I would typically prefer using Maven plugins like (maven-release-plugin, maven-docker-plugin, ...) as much as possible, but maybe that is no longer best practise.

I think for now this is the best approach. By the way, GitLab has a similar approach to defining workflows nowadays (https://docs.gitlab.com/ee/ci/quick_start/).

  • Currently, the version of the master is 1.2.6-SNAPSHOT, but we discussed the new version we want to release next week will have version 1.3.0. It feels a bit strange that despite there being version 1.2.6-SNAPSHOT there will never be an actual version 1.2.6. Is that a problem?

I think releasing 1.3.0 is fine.

Copy link
Collaborator

@bnouwt bnouwt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're ready to go!

@Sophietje Sophietje merged commit fc4046e into master Jan 14, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the release steps.
2 participants