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

Add Workflow to Build and Push Docker Images in Docker Hub #550

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mhmohona
Copy link
Member

Contributor checklist


Description

This GitHub Actions workflow builds and pushes a Docker image to Docker Hub whenever there is a push to the master branch or a manual trigger using workflow_dispatch. It simplifies Docker image deployment and supports multi-platform builds.

Requirements:

  • Docker Hub Credentials:
    • DOCKERHUB_USERNAME: Docker Hub username.
    • DOCKERHUB_TOKEN: Docker Hub personal access token.

Related issue

Copy link

github-actions bot commented Jan 12, 2025

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@mhmohona
Copy link
Member Author

@wkyoshida mention about this workflow long ago, but I completely forgot to add it. 😅

on:
push:
branches:
- master
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- master
- main

Aren't our default branch is main?

Copy link
Member

Choose a reason for hiding this comment

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

Beyond this, I think that it makes sense that the trigger for this is a release and not a push to main as we would only want full releases to go to Docker Hub.

@axif0
Copy link
Collaborator

axif0 commented Jan 12, 2025

Also can we add a checker if the repo is scribe-org/Scribe-Data ? like in matrix_dev_sync_reminder

CC: @andrewtavis

@andrewtavis
Copy link
Member

Ya that'd be really great so forks don't try to push :)

@andrewtavis
Copy link
Member

Ya that'd be really great so forks don't try to push :)

Beyond my comment above, let's make sure to add an explicit comment to the code that checks for the repo, as if someone does want to fork and host their fork on Docker Hub, then there's really no problem with that. It would be good if we made it clear where the change would need to go to disable the repo check 😊

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.

3 participants