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.

Sign up for GitHub

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

Jump to bottom

Update maintainers docs #23

Merged
merged 1 commit into from
Nov 13, 2023
Merged

Update maintainers docs #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Maintaining the docker/welcome-to-docker Image

The image is stored on Docker Hub at the `docker/welcome-to-docker` repo.
This document is for maintainers of this repository.

For the `latest` tag, we are using the `small-image` branch to make the first walkthrough user experience optimal. Any changes in `main` should be merged into `small-image` also.
## Docker Hub Image

To push a change to the welcome-to-docker Hub image:
```
The image is stored on Docker Hub in the [`docker/welcome-to-docker`](https://hub.docker.com/r/docker/welcome-to-docker) repository.

For the `latest` tag, we are using the `small-image` branch to make the first walkthrough user experience optimal. Every commit to `main` will be automatically merged to `small-image` via GitHub Actions.

## Deploying Changes

We do not currently have automation for pushing the changes to the image repository, so this is a manual step. First, wait for `small-image` to have the changes merged in and then run the following to build and push:
```bash
git checkout small-image
docker buildx create --name mybuilder --use --bootstrap # only if not created before
docker buildx build --push --platform linux/amd64,linux/arm64 --tag docker/welcome-to-docker .
```

Be sure to verify the changes. Run the following command and visit http://localhost:8088 to verify the changes were successfully deployed.

```bash
docker run --pull always -p 8088:80 docker/welcome-to-docker:latest
```
Loading