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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 6 additions & 6 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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
```

0 commit comments

Comments
 (0)