Skip to content

Conversation

@Exairnous
Copy link
Member

What?

Adds a workflow for building custom Docker images of branches and pushing them to the container registry of your choice.

Why?

This enables easy, reproducible builds of Docker images and should help make it easier to customize Community Edition instances, test pull requests/development branches, and provide Docker images of long running branches (large alpha/beta features) for community testing.

Examples

2026-02-10_05-38

How to test

  1. Merge this into the default branch of your fork.
  2. Go to Actions > custom-docker-build-push in your fork.
  3. Click on the Run workflow button.
  4. Fill in the details (see the documentation linked below for more info on this).
  5. Click on the Run workflow button at the bottom of the panel you just filled out with details.
  6. See that the workflow completes successfully and the Docker images have been pushed to your container registry (assuming there are no bugs in the branch which prevent it from building).
  7. Undo merging this into the default branch of your fork (e.g. run git reset --hard HEAD~1 on your default branch and force push).

Documentation of functionality

This is already present at https://github.com/Hubs-Foundation/hubs-docs/blob/master/docs/dev-github-workflows.md / https://docs.hubsfoundation.org/github-workflows.html

Limitations

Not all the utilities that are incorporated in this workflow are necessarily at their latest version (e.g. actions/checkout). This is done in order to keep it in sync with the rest of the implementations of the workflow in the other repositories.

Alternatives considered

None.

Open questions

None.

Additional details or related context

Part of [Hubs-Foundation/.github] Add Custom Docker Build Push action to all Community Edition service repositories (Issue #7)

What: Adds a workflow for building custom Docker images of branches and pushing them to the container registry of your choice.

Why: This enables easy, reproducible builds of Docker images and should help make it easier to customize Community Edition instances, test pull requests/development branches, and provide Docker images of long running branches (large alpha/beta features) for community testing.

Notes:

* This allows Docker images with a custom tag/name to be created on demand for any branch containing this workflow and pushed to the specified Docker repository.  Two versions of the Docker image will always be pushed, one ending with -latest and one ending with the workflow run number, e.g. my-custom-image-name-latest and my-custom-image-name-42.

* The default tag/name of the images is the branch name.

* The details required for the workflow to run can either be provided by predefined repository secrets/variables or specified manually when invoking the workflow, the rest are baked into the workflow and should be good most of the time, but can be overridden when invoking the workflow, if needed.

* More information on this workflow can be found at either https://docs.hubsfoundation.org/github-workflows.html or https://github.com/Hubs-Foundation/hubs-docs/blob/master/docs/dev-github-workflows.md
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.

1 participant