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

chore: publish docker image to GHCR; add helm chart #44

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

invakid404
Copy link
Contributor

This PR adds a GitHub Actions workflow which builds and publishes the Docker
image to GitHub's Docker image repository (GHCR), and adds a Helm chart for ease
of deployment in Kubernetes.

To get the GitHub Actions workflow up and running, two secrets need to be added
to the repository:

  • GHCR_USERNAME: the username of the repository owner (in this case, trashhalo)
  • GHCR_TOKEN: a GitHub personal access token which has the write:packages
    scope

The workflow runs when a new release is created and automatically builds and
tags a Docker image with both the tag name and latest.

For the Helm chart to be usable, an index.yaml file needs to be hosted
somewhere. For example, it can be hosted on GitHub Pages. Here's a
guide on how to create a Helm
chart repository.

Note that the Helm chart can only set the two environment variables that are
documented in the README. I noticed that there are other environment variables
in use throughout the codebase, but I'm not familiar with them. It could be
extended in the future with those as well.

@trashhalo
Copy link
Owner

Thanks for this pr. Ill take a deeper look at it this weekend

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.

2 participants