When documenting CI/CD processes, build pipelines, or deployment workflows, use clear and precise language that helps developers understand the sequence of operations. Write in present tense to describe what tools do, and provide explicit references when explaining examples.
When documenting CI/CD processes, build pipelines, or deployment workflows, use clear and precise language that helps developers understand the sequence of operations. Write in present tense to describe what tools do, and provide explicit references when explaining examples.
Key practices:
Example of clear CI/CD documentation:
### Use Dry Run mode to test your command
Use `--dry-run` flag to test a command without changing your application stack state.
Dry Run mode shows you all the steps Compose applies when executing a command, for example:
```console
$ docker compose --dry-run up --build -d
[+] Running 10/8
✔ DRY-RUN MODE - Container nginx-golang-mysql-db-1 Created
✔ DRY-RUN MODE - Container nginx-golang-mysql-backend-1 Created
From the example above, you can see that the first step is to pull the image defined by db
service, then build the backend
service.
```
This approach ensures that team members can easily follow and understand CI/CD processes, reducing confusion during deployment and build operations.
Enter the URL of a public GitHub repository