diff --git a/docs/reference-guide/cookieplone-make-commands.md b/docs/reference-guide/cookieplone-make-commands.md index 22b3c1e18..ee2f98e7e 100644 --- a/docs/reference-guide/cookieplone-make-commands.md +++ b/docs/reference-guide/cookieplone-make-commands.md @@ -11,16 +11,7 @@ myst: This reference guide describes the function and purpose of all the `make` commands found in a {term}`Cookieplone` project. It's organized according to its components. -- Frontend -- Backend -- Documentation -- Environment -- Quality assurance (QA) -- Internationalization (i18n) -- Testing -- Container images -- Local stack -- Acceptance + ## Frontend @@ -160,4 +151,66 @@ You can run the following make targets by using the command structure of `make < `build-images` : Invokes the target `build-image` in both `backend/Makefile` and `frontend/Makefile`. - This builds Docker images for both backend and frontend. \ No newline at end of file + This builds Docker images for both backend and frontend. + + +## Devops + +Cookieplone projects include a `devops` folder when deployment-related questions are answered "Yes" during project generation. +These questions include the following. + +- Add Ansible playbooks? +- Add GitHub Action to Deploy this project? + +When any of these options are selected, Cookieplone generates a {file}`devops/Makefile` file containing deployment and CI/CD helper commands. + +You can view the available devops commands in your generated project by running the following help command from the project root. + +```shell +make -C devops help +``` + +Alternatively, change the working directory to {file}`devops` and run its help command. + +```shell +cd devops +make help +``` + +The available commands align with the selected Cookieplone template options. + +When all devops options have been selected, the following output is the result of running the devops help command. + +```console +# === DevOps Makefile Commands === +deploy Deploy the project using the configured provider +deploy-check Validate deployment configuration +deploy-ansible Run Ansible playbooks for provisioning +deploy-rollback Roll back the last deployment +deploy-status Show deployment status or active revision +secrets-edit Edit encrypted secrets +secrets-view View decrypted secrets +lint Lint Ansible and DevOps configuration files +format Format DevOps files (YAML, JSON, etc.) +clean Clean temporary deployment artifacts +help Show this help +``` + +These commands support devops tasks, such as: + +- provisioning via Ansible +- deploying through GitHub Actions or GitLab CI +- editing and viewing encrypted secrets +- linting devops configuration +- rolling back deployments + + +## Additional documentation + +The {file}`devops` folder also includes {file}`README*.md` files generated by Cookieplone, which contain deployment instructions tailored to your setup: + +- {file}`devops/README.md` +- {file}`devops/README-GHA.md` for GitHub Actions deployment +- {file}`devops/README-GITLAB.md` for GitLab deployment + +These documents provide details, such as provisioning steps, CI configuration, and environment requirements, and are the authoritative source of documentation for devops. \ No newline at end of file