Skip to content

Conversation

@dominiquekleeven
Copy link
Collaborator

@dominiquekleeven dominiquekleeven commented May 18, 2025

Closes #10

This PR introduces the following GitHub Actions workflows:

docker-image.yml

  • Triggered when a commit is pushed to main or when a release is published
  • Triggers ci.yml to run code quality checks
  • Sets the image tag:
    • If triggered by a release -> tags will be the release version and latest
    • Otherwise -> falls back to develop
  • Builds and publishes the Docker image for multiple platforms (amd64, arm64)

release.yml

based on the release.yml from the main repository

  • Triggered via manual workflow dispatch
  • Accepts inputs for the version increment (major, minor, patch) or a version override
  • Uses bump-my-version to handle version management:
    • Reads the current version from pyproject.toml
    • Calculates and updates the new version
    • Automatically commits the version change with the message chore: bump version to {version}. Python projects/packages expect the version to be explicitly maintained in pyproject.toml, so this automates that
    • Creates a git tag for the new version
  • Pushes the commit and tag to the main branch
  • Creates a GitHub release with auto-generated release notes
  • The release event will trigger the docker-image.yml flow

I've also reset the version back to the original 0.1.0, which will be incremented once releases are made.


Additionally, this PR includes minor changes to ci.yml, primarily aimed at improving readability/formatting, and adds a release.yml file to the root of the .github folder, which is used to generate the release notes.

I've also set up the secrets for the GitHub repository and created the repository on DockerHub.

@dominiquekleeven

This comment was marked as outdated.

@wborn wborn requested a review from Copilot September 5, 2025 08:50

This comment was marked as outdated.

This comment was marked as resolved.

@dominiquekleeven dominiquekleeven changed the title Added Release Workflow Added GitHub actions workflows for Docker build push + Releases Oct 2, 2025
@dominiquekleeven dominiquekleeven marked this pull request as ready for review October 2, 2025 12:38
@dominiquekleeven dominiquekleeven requested a review from a team October 2, 2025 12:41
@dominiquekleeven dominiquekleeven marked this pull request as draft October 2, 2025 13:01
@dominiquekleeven dominiquekleeven marked this pull request as ready for review October 2, 2025 13:13
@dominiquekleeven dominiquekleeven changed the title Added GitHub actions workflows for Docker build push + Releases Added GitHub Actions Release flow Oct 2, 2025
Copy link
Member

@denniskuijs denniskuijs left a comment

Choose a reason for hiding this comment

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

Code looks good to me, just a few minor changes.

workflow_dispatch:
inputs:
VERSION_INCREMENT:
description: "The version number part to increment (major.minor.patch)"
Copy link
Member

Choose a reason for hiding this comment

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

Small cosmetic change: replace double quotes with single quotes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed it to single quotes.

Seems they were accidentally changed to double quotes due to the formatter I use.

- name: Set up QEMU
uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
with:
platforms: all
Copy link
Member

Choose a reason for hiding this comment

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

Maybe only include the platforms that are necessary: linux/amd64,linux/arm64

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good catch, I've changed it so it specifies the platforms now.

@dominiquekleeven dominiquekleeven merged commit cc0f83a into main Oct 6, 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.

Add GitHub Actions Release flow

3 participants