Skip to content

Commit bc172b1

Browse files
antoinegellozThibaut-gauvin
authored andcommitted
fix: homogeneous dib lowercase naming
1 parent 92d2040 commit bc172b1

29 files changed

+77
-77
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to DIB
1+
# Contributing to dib
22
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
33

44
- Reporting a bug

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
DIB: Docker Image Builder
1+
dib: Docker Image Builder
22
=========================
33

44
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/radiofrance/dib?sort=semver)
55
![CI Status](https://img.shields.io/github/actions/workflow/status/radiofrance/dib/qa.yml?label=QA&logo=github-actions&logoColor=fff)
66
[![codecov](https://codecov.io/gh/radiofrance/dib/branch/main/graph/badge.svg)](https://codecov.io/gh/radiofrance/dib)
77
[![Go Report Card](https://goreportcard.com/badge/github.com/radiofrance/dib)](https://goreportcard.com/report/github.com/radiofrance/dib)
88

9-
DIB is a tool designed to help build multiple Docker images defined within a directory, possibly having dependencies
9+
dib is a tool designed to help build multiple Docker images defined within a directory, possibly having dependencies
1010
with one another, in a single command.
1111

1212
## Features
@@ -15,20 +15,20 @@ with one another, in a single command.
1515
- **Dependency Resolution:** Supports dependencies between images. Builds will be queued until all parent images are built, ensuring a smooth and efficient build process.
1616
- **Test Suites:** Run test suites on images and ensure the tests pass before promoting images to production.
1717
- **Build Backends:** Multiple build backends supported, including Docker/BuildKit and Kaniko. Choose the backend that best suits your needs.
18-
- **Execution Environments:** DIB supports multiple executors, allowing you to build images using different environments such as Shell, Docker, or Kubernetes.
18+
- **Execution Environments:** dib supports multiple executors, allowing you to build images using different environments such as Shell, Docker, or Kubernetes.
1919

2020
## Documentation
2121

22-
To get started with DIB, please read the [documentation](https://radiofrance.github.io/dib).
22+
To get started with dib, please read the [documentation](https://radiofrance.github.io/dib).
2323

2424
## Contributing
2525

26-
We welcome contributions from the community! If you'd like to contribute to DIB, please review our
26+
We welcome contributions from the community! If you'd like to contribute to dib, please review our
2727
[contribution guidelines](https://github.com/radiofrance/dib/blob/main/CONTRIBUTING.md) for more information.
2828

2929
## License
3030

31-
DIB is licensed under the [CeCILL V2.1 License](https://cecill.info/licences/Licence_CeCILL_V2.1-en.txt)
31+
dib is licensed under the [CeCILL V2.1 License](https://cecill.info/licences/Licence_CeCILL_V2.1-en.txt)
3232

3333
## Support
3434

cmd/list.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ import (
1414
// listCmd represents the output command.
1515
var listCmd = &cobra.Command{
1616
Use: "list",
17-
Short: "Print list of images managed by DIB",
18-
Long: `dib list will print a list of all Docker images managed by DIB`,
17+
Short: "Print list of images managed by dib",
18+
Long: `dib list will print a list of all Docker images managed by dib`,
1919
Run: func(cmd *cobra.Command, _ []string) {
2020
bindPFlagsSnakeCase(cmd.Flags())
2121

docs/backends.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Build Backends
22
==============
33

4-
The build backend is a software or service responsible for actually building the images. DIB itself is not capable of
4+
The build backend is a software or service responsible for actually building the images. dib itself is not capable of
55
building images, it delegates this part to the build backend.
66

7-
DIB supports multiple build backends. Currently, available backends are `docker` and `kaniko`. You can select the
7+
dib supports multiple build backends. Currently, available backends are `docker` and `kaniko`. You can select the
88
backend to use with the `--backend` option.
99

1010
**Executor compatibility matrix**
@@ -35,7 +35,7 @@ run on the remote host instead of using the local Docker daemon.
3535

3636
**BuildKit**
3737

38-
If available, DIB will try to use the BuildKit engine to build images, which is faster than the default Docker
38+
If available, dib will try to use the BuildKit engine to build images, which is faster than the default Docker
3939
build engine.
4040

4141
## Kaniko

docs/best-practices.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
DIB Best Practices
1+
dib Best Practices
22
==================
33

44
### Pin dependencies versions in Dockerfiles
55

6-
As DIB only rebuilds images when something changes in the build context (including the Dockerfile), external
6+
As dib only rebuilds images when something changes in the build context (including the Dockerfile), external
77
dependencies should always be pinned to a specific version, so upgrading the dependency triggers a rebuild.
88

99
Example:
@@ -13,5 +13,5 @@ RUN apt-get install [email protected]
1313

1414
### Use .dockerignore
1515

16-
The `.dockerignore` lists file patterns that should not be included in the build context. DIB also ignores those files
16+
The `.dockerignore` lists file patterns that should not be included in the build context. dib also ignores those files
1717
when it computes the checksum, so no rebuild is triggered when they are modified.

docs/configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Configuration
22
=============
33

4-
DIB can be configured either by command-line flags, environment variables or configuration file.
4+
dib can be configured either by command-line flags, environment variables or configuration file.
55

66
The command-line flags have the highest priority, then environment variables, then config file. You can set some
77
default values in the configuration file, and then override with environment variables of command-line flags.
@@ -15,7 +15,7 @@ dib build --registry-url=gcr.io/project
1515

1616
### Environment variables
1717

18-
DIB auto-discovers configuration from environment variables prefixed with `DIB_`, followed by the capitalized,
18+
dib auto-discovers configuration from environment variables prefixed with `DIB_`, followed by the capitalized,
1919
snake_cased flag name.
2020

2121
Example:
@@ -26,7 +26,7 @@ dib build
2626

2727
### Configuration file
2828

29-
DIB uses a YAML configuration file in addition to command-line arguments. It will look for a file names `.dib.yaml`
29+
dib uses a YAML configuration file in addition to command-line arguments. It will look for a file names `.dib.yaml`
3030
in the current working directory. You can change the file location by setting the `--config` (`-c`) flag.
3131

3232
The YAML keys are equivalent to the flag names, in snake_case.

docs/documentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Documentation
44
The documentation is generated with [`mkdocs`](https://www.mkdocs.org/). It generates a static website in plain HTML
55
from the Markdown files present in the `docs/` directory.
66

7-
We also use the [Cobra](https://github.com/spf13/cobra) built-in documentation generator for DIB commands.
7+
We also use the [Cobra](https://github.com/spf13/cobra) built-in documentation generator for dib commands.
88

99
## Local Setup
1010

docs/examples/config/reference.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ log_level: info
44

55
# URL of the registry where the images should be stored.
66
#
7-
# DIB will use the local docker configuration to fetch metadata about existing images. You may use the DOCKER_CONFIG
7+
# dib will use the local docker configuration to fetch metadata about existing images. You may use the DOCKER_CONFIG
88
# environment variable to set a custom docker config path.
99
# See the official Docker documentation (https://docs.docker.com/engine/reference/commandline/cli/#configuration-files).
1010
# The build backend must also be authenticated to have permission to push images.
1111
registry_url: registry.example.org
1212

13-
# The placeholder tag DIB uses to mark which images are the reference. Defaults to "latest".
13+
# The placeholder tag dib uses to mark which images are the reference. Defaults to "latest".
1414
# Change this value if you don't want to use "latest" tags, or if images may be tagged "latest" by other sources.
1515
placeholder_tag: latest
1616

docs/executors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Executors
22
=========
33

4-
DIB supports multiple build executors. An executor is a platform able to run image builds and tests.
4+
dib supports multiple build executors. An executor is a platform able to run image builds and tests.
55
Unlike the build backends which can be explicitely chosen, the executor is automatically selected depending on the type
66
of operation (build, test), and the executors configured in the configuration file.
77

@@ -24,7 +24,7 @@ Runs commands in a docker container, using the `docker run` command.
2424
## Kubernetes
2525

2626
Creates pods in a kubernetes cluster, using the kubernetes API.
27-
DIB uses the current kube context, please make do
27+
dib uses the current kube context, please make do
2828

2929
See an example configuration in the
3030
[configuration reference](configuration-reference.md) section.

docs/extra-tags.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Extra Tags
22
==========
33

4-
Images managed by DIB will get tagged with the human-readable version of the computed hash. This is not very convenient
4+
Images managed by dib will get tagged with the human-readable version of the computed hash. This is not very convenient
55
in some cases, for instance if we want to tag an image with the explicit version of the contained software.
66

7-
DIB allows additional tags to be definedusing a label in the Dockerfile:
7+
dib allows additional tags to be definedusing a label in the Dockerfile:
88
```dockerfile
99
LABEL dib.extra-tags="v1.0.0,v1.0,v1"
1010
```

docs/index.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Introduction
22
============
33

4-
DIB is a tool designed to help build multiple Docker images defined within a directory, possibly having dependencies
4+
dib is a tool designed to help build multiple Docker images defined within a directory, possibly having dependencies
55
with one another, in a single command.
66

77
/// admonition | Warning
88
type: warning
99

10-
DIB is still at an early stage, development is still ongoing and new minor releases may bring some breaking changes.
10+
dib is still at an early stage, development is still ongoing and new minor releases may bring some breaking changes.
1111
This may occur until we release the v1.
1212
///
1313

@@ -24,16 +24,16 @@ efficiency, but it's not an easy task.
2424

2525
Also, being able to test and validate the produced images was also something that we were looking forward to.
2626

27-
DIB was created to solve these issues, and manage a large number of images in the most efficient way as possible.
27+
dib was created to solve these issues, and manage a large number of images in the most efficient way as possible.
2828

2929
## Concepts
3030

31-
Before using DIB, there are important basic concepts to know about, to understand how it works internally.
31+
Before using dib, there are important basic concepts to know about, to understand how it works internally.
3232

3333
### Build Directory
3434

35-
DIB needs a path to a root directory containing all the images it should manage. The structure of this directory is not
36-
important, DIB will auto-discover all the Dockerfiles within it recursively.
35+
dib needs a path to a root directory containing all the images it should manage. The structure of this directory is not
36+
important, dib will auto-discover all the Dockerfiles within it recursively.
3737

3838
Example with a simple directory structure:
3939
```
@@ -52,12 +52,12 @@ In order to be discovered, the Dockerfile must contain the `name` label:
5252
LABEL name="alpine"
5353
```
5454

55-
If the `name` label is missing, the image will be ignored and DIB won't manage it.
55+
If the `name` label is missing, the image will be ignored and dib won't manage it.
5656

5757
### Dependency Graph
5858

5959
Because some images may depend on other images (when a `FROM` statement references an image also defined within the
60-
build directory), DIB internally builds a graph of dependencies (DAG). During the build process, DIB waits until all
60+
build directory), dib internally builds a graph of dependencies (DAG). During the build process, dib waits until all
6161
parent images finish to build before building the children.
6262

6363
Example dependency graph:
@@ -69,23 +69,23 @@ graph LR
6969
B --> E;
7070
```
7171

72-
In this example, DIB will wait for the `alpine` image to be built before proceeding to `nodejs`, and then both
72+
In this example, dib will wait for the `alpine` image to be built before proceeding to `nodejs`, and then both
7373
`alpine` and `bullseye` can be built in parallel (see the [`--rate-limit`](cmd/dib_build.md) build option).
7474

7575
Once `debian` is completed, the build of `bar` begins, and as soon as `nodejs` is completed, `foo` follows.
7676

7777
### Image Version Tag
7878

79-
DIB only builds an image when something has changed in its build context since the last build. To track the changes,
80-
DIB computes a checksum of all the files in the context, and generates a human-readable tag out of it. If any file
79+
dib only builds an image when something has changed in its build context since the last build. To track the changes,
80+
dib computes a checksum of all the files in the context, and generates a human-readable tag out of it. If any file
8181
changes in the build context (or in the build context of any parent image), the computed human-readable tag changes as
8282
well.
8383

84-
DIB knows it needs to rebuild an image if the target tag is not present in the registry.
84+
dib knows it needs to rebuild an image if the target tag is not present in the registry.
8585

8686
### Placeholder Tag
8787

88-
When updating images having children, DIB needs to update the tags in `FROM` statements in all child images
88+
When updating images having children, dib needs to update the tags in `FROM` statements in all child images
8989
before running the build, to match the newly computed tag.
9090

9191
**Example:**
@@ -122,16 +122,16 @@ Then any change to the parent image **will not** be inherited by the child.
122122

123123
### Tag promotion
124124

125-
DIB always tries to build and push images when it detects some changes, by it doesn't move the reference tag
126-
(`latest` by default) to the latest version. This allows DIB to run on feature branches without interfering with
127-
one another. Once the changes are satisfying, just re-run DIB with the `--release` flag to promote the current
125+
dib always tries to build and push images when it detects some changes, by it doesn't move the reference tag
126+
(`latest` by default) to the latest version. This allows dib to run on feature branches without interfering with
127+
one another. Once the changes are satisfying, just re-run dib with the `--release` flag to promote the current
128128
version with the reference tag.
129129

130130
**Example workflow**
131131

132-
Let's assume we have a simple GitFlow setup, with CI/CD pipelines running on each commit to build docker images with DIB.
132+
Let's assume we have a simple GitFlow setup, with CI/CD pipelines running on each commit to build docker images with dib.
133133

134-
When one creates a branch from the main branch, and commits some changes to an image. DIB builds and pushes the
134+
When one creates a branch from the main branch, and commits some changes to an image. dib builds and pushes the
135135
`cat-south` tag, but `latest` still references the same tag (`beacon-two`):
136136

137137
```mermaid
@@ -156,4 +156,4 @@ gitGraph
156156

157157
## License
158158

159-
DIB is licensed under the [CeCILL V2.1 License](https://cecill.info/licences/Licence_CeCILL_V2.1-en.txt)
159+
dib is licensed under the [CeCILL V2.1 License](https://cecill.info/licences/Licence_CeCILL_V2.1-en.txt)

docs/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Installation Guide
1515

1616
## Shell autocompletion
1717

18-
Configure your shell to load DIB completions:
18+
Configure your shell to load dib completions:
1919

2020
=== "Bash"
2121

docs/quickstart.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
Quickstart Guide
22
================
33

4-
This guide will show you the basics of DIB. You will build a set of images locally using the local docker daemon.
4+
This guide will show you the basics of dib. You will build a set of images locally using the local docker daemon.
55

66
## Prerequisites
77

8-
Before using DIB, ensure you have the following dependencies installed:
8+
Before using dib, ensure you have the following dependencies installed:
99

1010
- [Docker](https://www.docker.com/) for building images on your local computer.
1111
- [Graphviz](https://graphviz.org/) for generating visual representation of the dependency graph (optional)
1212
- [Goss](https://github.com/goss-org/goss) for testing images after build (optional)
1313
- [Trivy](https://aquasecurity.github.io/trivy) for scanning images for vulnerabilites (optional)
1414

15-
Then, you need to install the DIB command-line by following the [installation guide](install.md).
15+
Then, you need to install the dib command-line by following the [installation guide](install.md).
1616

1717
Make sure you have authenticated access to an OCI registry, in this guide we'll assume it is `registry.example.com`.
1818

@@ -36,7 +36,7 @@ FROM alpine:latest
3636
LABEL name="base"
3737
```
3838

39-
The "name" label is mandatory, it is used by DIB to name the current image, by appending the value of the label to the
39+
The "name" label is mandatory, it is used by dib to name the current image, by appending the value of the label to the
4040
registry URL. In this case, the image name is `registry.example.com/base`.
4141

4242
Then, create the dockerfile for the `child` image, which extends the `base` image:
@@ -50,7 +50,7 @@ LABEL name="child"
5050
/// admonition | Tip
5151
type: tip
5252

53-
The directory structure does not matter to DIB. It builds the graph of dependencies based on the FROM statements.
53+
The directory structure does not matter to dib. It builds the graph of dependencies based on the FROM statements.
5454
You can have either flat directory structure like shown above, or embed child images context directories
5555
in the parent context.
5656
///
@@ -69,7 +69,7 @@ docker/
6969
└── .dib.yaml
7070
```
7171

72-
Edit the file to set the registry name, used to pull and push DIB-managed images.
72+
Edit the file to set the registry name, used to pull and push dib-managed images.
7373
```yaml
7474
registry_url: registry.example.com
7575
```
@@ -83,7 +83,7 @@ Using config file: docs/examples/.dib.yaml
8383
child gee-minnesota-maryland-robin
8484
```
8585

86-
You should get the output containing the list of images that DIB has discovered.
86+
You should get the output containing the list of images that dib has discovered.
8787

8888
## Building the images
8989

@@ -94,7 +94,7 @@ $ dib build
9494
...
9595
```
9696

97-
When it's done, you can run the build command again, and you'll see that DIB does nothing as long as the Dockerfiles
97+
When it's done, you can run the build command again, and you'll see that dib does nothing as long as the Dockerfiles
9898
remain unchanged.
9999

100100
When you are ready to promote the images to `latest`, run:

docs/reports.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
Reporting
22
=========
33

4-
DIB generates reports after each build.
4+
dib generates reports after each build.
55
By default, the reports are generated in the `reports` directory. You can change it by setting the
66
`--reports-dir` option to another location.
77

88
## HTML Report
99

1010
The HTML report is the one you are going to use the most.
11-
Just click on the link displayed on the DIB output to browse the report.
11+
Just click on the link displayed on the dib output to browse the report.
1212

1313
In the report you'll find:
1414

15-
- An overview of all images managed by DIB
15+
- An overview of all images managed by dib
1616
- The build output
1717
- The graph of dependencies
1818
- Test results and logs

docs/roadmap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Roadmap
33

44
## Road to v1
55

6-
DIB is still a work in progress, but we plan to release a stable version (v1.0.0) after we have added the
6+
dib is still a work in progress, but we plan to release a stable version (v1.0.0) after we have added the
77
following features:
88

99
- **Per-image configuration:** Some images may require their own tagging scheme. Being

0 commit comments

Comments
 (0)