Skip to content

Commit 53a8eab

Browse files
janishorstsjanishorsts
committed
chore: fix update docker hub readme flow
1 parent f94ac88 commit 53a8eab

File tree

5 files changed

+80
-141
lines changed

5 files changed

+80
-141
lines changed

‎.github/renovate.json5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
{
6969
customType: 'regex',
7070
managerFilePatterns: [
71-
'/docs/dockerhub.md$/',
71+
'README.md$/',
7272
],
7373
matchStrings: [
7474
'\\*\\s+\\`(?<currentValue>.+?)\\`\\n',

‎.github/workflows/update_readme.yml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ name: Update Docker Hub README
22

33
on:
44
push:
5-
branches: [ main ]
6-
paths: [ docs/dockerhub.md ]
5+
# branches: [ main ]
6+
# paths: [ README.md ]
77

88
jobs:
99
update-docker-hub-readmes:
@@ -16,11 +16,10 @@ jobs:
1616
- uses: actions/checkout@v4
1717
with:
1818
token: ${{ secrets.GITHUB_TOKEN }}
19-
- name: Update DockerHub description for earthly/dind
19+
- name: Update DockerHub description for earthbuild/dind
2020
uses: peter-evans/[email protected]
2121
with:
2222
username: ${{ secrets.DOCKERHUB_USERNAME }}
2323
password: ${{ secrets.DOCKERHUB_TOKEN }}
24-
repository: earthly/dind
25-
readme-filepath: ./docs/dockerhub.md
26-
short-description: Earthly dind (Docker In Docker) Images
24+
repository: earthbuild/dind
25+
short-description: The `dind` image is designed for EarthBuild targets that use the `WITH DOCKER` command

‎CONTRIBUTING.md

Lines changed: 61 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,68 @@
44

55
Please refer to the [CNCF Community Code of Conduct v1.0](https://github.com/cncf/foundation/blob/main/code-of-conduct.md)
66

7-
## CLA
7+
## How Images are Built
88

9-
### Individual
9+
In this repository, we maintain the OS & Docker versions that warrants releasing a new version of the image.
10+
However, the installations of docker and other dependencies are done via an installation script that is currently maintained in [earthbuild/earthbuild](https://github.com/earthbuild/earthbuild).
1011

11-
All contributions must indicate agreement to the [Earthly Contributor License Agreement](https://gist.github.com/vladaionescu/ed990fa149a38a53ac74b64155bc6766) by logging into GitHub via the CLA assistant and signing the provided CLA. The CLA assistant will automatically notify the PRs that require CLA signing.
12+
### Dependencies
1213

13-
### Entity
14+
Dependencies are maintained by Renovate and will be merged automatically (provided required checks pass), primarly
15+
dependencies that will trigger new versions of the dind images such as the docker or the os (alpine) versions.
1416

15-
If you are an entity, please use the [Earthly Contributor License Agreement form](https://earthly.dev/cla-form) in addition to requiring your individual contributors to sign all contributions.
17+
## Repo structure
18+
19+
```bash
20+
.
21+
├── Earthfile // Targets that apply to all images (e.g. +test)
22+
├── common
23+
│ └── Earthfile // A library of common helper targets
24+
└── os // Each directory contains an Earthfile with targets to maintain the specific os (e.g. +test, +build)
25+
├── alpine
26+
│ └── Earthfile
27+
├── ubuntu-20.04
28+
│ └── Earthfile
29+
└── ubuntu-23.04
30+
└── Earthfile
31+
└── ubuntu-24.04
32+
└── Earthfile
33+
```
34+
35+
## Testing
36+
37+
Images are tested by running remote test targets that are maintained in [earthbuild/earthbuild](https://github.com/earthbuild/earthbuild/tree/main/tests/with-docker). This is because these tests also help test [WITH DOCKER](https://docs.earthly.dev/docs/earthfile#with-docker) command in earthly cli.
38+
39+
Temporary images are built, pushed, and pulled as part of the test cycle.
40+
41+
### How to run tests
42+
43+
* Test a specific image os:
44+
45+
```bash
46+
earthly --push -P ./os/<os>+test-build
47+
```
48+
49+
* Test all images:
50+
```bash
51+
earthly --push -P +test
52+
```
53+
54+
#### Community members
55+
56+
Community members do not have permissions to push a built image and run the tests against it. However, they can easily set a different container registry repository by changing the `CR_HOST` (default: ghcr.io) and `CR_ORG` ARG values in [.arg](.arg) to a private container registry repository or by passing the args in the earthly command, e.g. `earthly --push -P +test --CR_HOST=<your-container-registry> --CR_ORG=<your-organization>`.
57+
58+
## Deployment
59+
60+
When the relevant dependencies are updated by Renovate, new images/tags will be pushed automatically to the container registries - [ghcr.io/earthbuild/dind](https://ghcr.io/earthbuild/dind) and [earthbuild/dind](https://hub.docker.com/r/earthlbuild/dind).
61+
62+
## Contributing
63+
64+
* Please report bugs as [GitHub issues](https://github.com/earthbuild/dind/issues).
65+
* Join us on [Slack](https://earthly.dev/slack)!
66+
* Questions via GitHub issues are welcome!
67+
* PRs welcome! But please give a heads-up in a GitHub issue before starting work. If there is no GitHub issue for what you want to do, please create one.
68+
69+
## Licensing
70+
71+
Earthly is licensed under the Mozilla Public License Version 2.0. See [LICENSE](./LICENSE).

‎README.md

Lines changed: 13 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,22 @@
1-
# EarthBuild dind (Docker In Docker) Images
2-
[![Release](https://github.com/earthbuild/dind/actions/workflows/release.yml/badge.svg)](https://github.com/earthbuild/dind/actions/workflows/release.yml)
3-
![Docker Pulls](https://img.shields.io/docker/pulls/earthbuild/dind)
1+
[![Release](https://github.com/earthbuild/dind/actions/workflows/release.yml/badge.svg)](https://github.com/earthbuild/dind/actions/workflows/release.yml) ![Docker Pulls](https://img.shields.io/docker/pulls/earthbuild/dind)
42

3+
The `dind` (docker-in-docker) image is designed for EarthBuild targets that use the `WITH DOCKER` command.
54

6-
EarthBuilds's official [ghcr.io/earthbuild/dind](https://ghcr.io/earthbuild/dind) and [earthbuild/dind](https://hub.docker.com/r/earthlbuild/dind) container images.
75
For information on how to use these images, please refer to [docker in EarthBuild](https://docs.earthly.dev/docs/guides/docker-in-earthly).
86

97
## Supported Distributions
108

11-
There are currently 4 supported dind distributions available:
12-
- `alpine`
13-
- `ubuntu:20.04`
14-
- `ubuntu:23.04`
15-
- `ubuntu:24.04`
9+
This image supports the following Linux distributions:
10+
* alpine
11+
* ubuntu:20.04
12+
* ubuntu:23.04
13+
* ubuntu:24.04
1614

17-
Other distributions and/or base images can be used with our [dind+INSTALL](https://docs.earthly.dev/docs/guides/docker-in-earthly#performance) [FUNCTION](https://docs.earthly.dev/docs/guides/functions).
15+
For which the current latest tags (respectively) are:
16+
* `alpine-3.22-docker-28.3.0-r0`
17+
* `ubuntu-20.04-docker-28.1.1-1`
18+
* `ubuntu-23.04-docker-25.0.2-1`
19+
* `ubuntu-24.04-docker-28.3.2-1`
1820

19-
## How Images are Built
21+
For other available tags, please check out [ghcr.io/earthbuild/dind](https://github.com/EarthBuild/dind/pkgs/container/dind/versions?filters%5Bversion_type%5D=tagged) or [earthbuild/dind](https://hub.docker.com/r/earthbuild/dind/tags).
2022

21-
In this repository, we maintain the OS & Docker versions that warrants releasing a new version of the image.
22-
However, the installations of docker and other dependencies are done via an installation script that is currently maintained in [earthbuild/earthbuild](https://github.com/earthbuild/earthbuild).
23-
24-
### Dependencies
25-
26-
Dependencies are maintained by Renovate and will be merged automatically (provided required checks pass), primarly
27-
dependencies that will trigger new versions of the dind images such as the docker or the os (alpine) versions.
28-
29-
## Repo structure
30-
31-
```bash
32-
.
33-
├── Earthfile // Targets that apply to all images (e.g. +test)
34-
├── common
35-
│ └── Earthfile // A library of common helper targets
36-
└── os // Each directory contains an Earthfile with targets to maintain the specific os (e.g. +test, +build)
37-
├── alpine
38-
│ └── Earthfile
39-
├── ubuntu-20.04
40-
│ └── Earthfile
41-
└── ubuntu-23.04
42-
└── Earthfile
43-
└── ubuntu-24.04
44-
└── Earthfile
45-
```
46-
47-
## Testing
48-
49-
Images are tested by running remote test targets that are maintained in [earthbuild/earthbuild](https://github.com/earthbuild/earthbuild/tree/main/tests/with-docker). This is because these tests also help test [WITH DOCKER](https://docs.earthly.dev/docs/earthfile#with-docker) command in earthly cli.
50-
51-
Temporary images are built, pushed, and pulled as part of the test cycle.
52-
53-
### How to run tests
54-
55-
* Test a specific image os:
56-
57-
```bash
58-
earthly --push -P ./os/<os>+test-build
59-
```
60-
61-
* Test all images:
62-
```bash
63-
earthly --push -P +test
64-
```
65-
66-
#### Community members
67-
68-
Community members do not have permissions to push a built image and run the tests against it. However, they can easily set a different container registry repository by changing the `CR_HOST` (default: ghcr.io) and `CR_ORG` ARG values in [.arg](.arg) to a private container registry repository or by passing the args in the earthly command, e.g. `earthly --push -P +test --CR_HOST=<your-container-registry> --CR_ORG=<your-organization>`.
69-
70-
## Deployment
71-
72-
When the relevant dependencies are updated by Renovate, new images/tags will be pushed automatically to the container registries - [ghcr.io/earthbuild/dind](https://ghcr.io/earthbuild/dind) and [earthbuild/dind](https://hub.docker.com/r/earthlbuild/dind).
73-
74-
## Contributing
75-
76-
* Please report bugs as [GitHub issues](https://github.com/earthbuild/dind/issues).
77-
* Join us on [Slack](https://earthly.dev/slack)!
78-
* Questions via GitHub issues are welcome!
79-
* PRs welcome! But please give a heads-up in a GitHub issue before starting work. If there is no GitHub issue for what you want to do, please create one.
80-
* Check the [contributing page](./CONTRIBUTING.md) for more details.
81-
82-
## Licensing
83-
84-
Earthly is licensed under the Mozilla Public License Version 2.0. See [LICENSE](./LICENSE).

‎docs/dockerhub.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

0 commit comments

Comments
 (0)