Skip to content

Commit ee829d2

Browse files
committed
Update README with Docker Hub push details
1 parent 50a6e91 commit ee829d2

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Be the change et al if Windows is your main and you wanna [raise a PR](CONTRIBUT
2020
* [Setup](#setup)
2121
* [Usage](#usage)
2222
* [Mac and Linux users](#mac-and-linux-users)
23+
* [Pushing to Docker Hub with CI](#pushing-to-docker-hub-with-ci)
2324
* [TODO](#todo)
2425

2526
## Setup
@@ -37,6 +38,19 @@ Be the change et al if Windows is your main and you wanna [raise a PR](CONTRIBUT
3738
### Mac and Linux users
3839
Development environments and tooling are first-class citizens on macOS and *nix. For Windows faithfuls, please setup [WSL](markdown/wsl.md).
3940

41+
## Pushing to Docker Hub with CI
42+
Docker Hub is a cloud-based repository in which Docker users and partners create, test, store and distribute container images. Docker images are pushed to Docker Hub through the docker push command. A single Docker Hub repository can hold many Docker images (stored as tags).
43+
44+
Automated CI is implemented via GitHub Actions to build and push this repository's image to Docker Hub in `/.github/workflows/push.yml`.
45+
46+
### What you need to modify in this file
47+
48+
* Look for `images: your-username/your-image-name` and change to your respective Docker Hub username and image name.
49+
* Add repository secrets for `DOCKERHUB_TOKEN` and `DOCKERHUB_USERNAME` on this repository on GitHub.
50+
* Here are the [instructions to create a token](https://docs.docker.com/docker-hub/access-tokens/#create-an-access-token).
51+
52+
Here are the [instructions to disable this action](https://docs.github.com/en/actions/managing-workflow-runs/disabling-and-enabling-a-workflow) if you don't want this feature.
53+
4054
## TODO
4155
* [Open Issues](https://github.com/pythoninthegrass/python_template/issues)
4256
* Markdown automation

0 commit comments

Comments
 (0)