vrtmrz / livesync-bridge

44 stars 6 forks source link

Add all stuff to Dockerize the project #7

Closed CanardConfit closed 8 months ago

CanardConfit commented 10 months ago

I really like what you do, so since I have a template ready to make any project dockerized automatically, I'm sharing it with you, with a quick explanation of how to go about it. xshyne already made a pull request (#4) to add some Docker related stuff, but not everything is there.

Dockerize your project

  1. Create and store tokens and auth in secret variables of actions: https://github.com/vrtmrz/livesync-bridge/settings/secrets/actions
  2. Create repository on hub.docker.com and quay.io.
    1. For quay,io, if you (want to) use a robot account token, you must add this robot to the repository in settings.
  3. Launch manual workflow to test if all is done.
  4. If all is done, create a tag and the release workflow will run automatically!

Secret keys needed for Actions

Name Description
DOCKERHUB_TOKEN Access token from https://hub.docker.com/settings/security
DOCKERHUB_PASSWORD Your docker account password
DOCKERHUB_USERNAME Your docker account username
QUAY_USERNAME Your quay account username or robot account username
QUAY_TOKEN Your quay CLI token or robot accounttoken
CR_PAT GitHub token https://github.com/settings/tokens