@@ -47,26 +47,25 @@ It contains the following parts :
4747- [x] pre-commit hooks: use `` ruff `` to ensure the code quality & `` detect-secrets `` to scan the secrets in the code.
4848- [x] Logging using loguru (with colors)
4949- [x] Pytest for unit tests
50- - [x] Dockerized project (Dockerfile & docker-compose): for the evaluation pipeline.
50+ - [x] Dockerized project (Dockerfile) both for development and production
5151- [x] Make commands to handle everything for you: install, run, test
5252
5353** CI/CD & Maintenance tools:**
5454
5555- [x] CI/CD pipelines: `` .github/workflows `` for GitHub
5656- [x] Local CI/CD pipelines: GitHub Actions using `` github act ``
57+ - [x] GitHub Actions for deploying to GitHub Pages with mkdocs gh-deploy
58+ - [x] Dependabot for automatic dependency and security updates
5759
5860** Documentation tools:**
5961
6062- [x] Wiki creation and setup of documentation website using Mkdocs
61- - [x] GitHub Pages deployment using mkdocs gh-deploy plugin
63+ - [x] GitHub Actions for deploying to GitHub Pages with mkdocs gh-deploy
6264
6365
6466Upcoming features:
65-
66- - [ ] add Dependabot
6767- [ ] optimize caching in CI/CD
6868- [ ] [ Pull requests templates] ( https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository )
69- - [ ] deploy gh pages in actions
7069
7170
7271## 1. Getting started
@@ -82,6 +81,7 @@ The following files are used in the contribution pipeline:
8281- `` src/python_package_tempalte/utils.py `` : logger using logguru and settings using pydantic.
8382 the frontend.
8483- ` .github/workflows/**.yml ` : GitHub actions configuration files.
84+ - `` .github/dependabot.yml `` : dependabot configuration file.
8585- `` .gitignore `` : contains the files to ignore in the project.
8686
8787### 1.1. Local Prerequisites
0 commit comments