Nekmo / amazon-dash

Hack your Amazon Dash to run what you want.
MIT License
829 stars 67 forks source link

Add Docker support #77

Closed bachya closed 6 years ago

bachya commented 6 years ago

This PR adds support for hosting and running Amazon Dash within a Docker container (#61).

Below are instructions on how to correctly host a Docker image on Docker Hub going forward.

Set up Docker

  1. Install Docker in your environment: About Docker CE | Docker Documentation

Set up a Docker Hub Repo

  1. Create an account at https://hub.docker.com/.
  2. Click on "Create Repository".
  3. Fill out the properties and create the repo.

Create an Automated Build Process

At the Docker Hub website:

  1. Click "Create" >> "Create Automated Build"
  2. Link your GitHub account, then click "Create Auto-build GitHub".
  3. Find and select the nekmo/amazon-dash repo.
  4. Fill out the details and click "Create".
  5. Click on "Build Settings" and set up your settings as needed. I think two rules makes sense to start, but you make the call:
    1. Branchmaster/latest
    2. Tag<EMPTY>/<Same as tag>

Push As Normal

With the above rules, the following will occur anytime you push:

  1. Any commit pushed to master will trigger a Docker build to the latest tag.
  2. Any tagged commit will trigger a Docker build to the tag that matches.

Feel free to add me as a collaborator to this Docker repo; happy to help you maintain while you get your feet under you!

Lastly, I think the docs are sufficient and correct, but let me know if more is needed.

codecov[bot] commented 6 years ago

Codecov Report

Merging #77 into develop will decrease coverage by 0.23%. The diff coverage is 0%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop      #77      +/-   ##
===========================================
- Coverage     95.2%   94.96%   -0.24%     
===========================================
  Files           19       19              
  Lines         1188     1191       +3     
===========================================
  Hits          1131     1131              
- Misses          57       60       +3
Impacted Files Coverage Δ
amazon_dash/config.py 84.12% <0%> (-4.21%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update ca2829a...365c8f0. Read the comment docs.

Nekmo commented 6 years ago

Everything seems to be correct :+1: I have to check that it works on my machine and will be included in Amazon-dash 1.2.0.

Do you want to be added to the contributors section?

bachya commented 6 years ago

@Nekmo Happy to join as a contributor! I can help with the Docker Hub stuff that way, too.

Nekmo commented 6 years ago

@bachya It's done. Thank you :)

bachya commented 6 years ago

@Nekmo If you'd like me to manage the Docker Hub stuff, you'll either need me to make me a co-owner of this repo or set up the Docker Hub repo and make me a co-owner there.