From ed83040d0bcf6f878e670b8e6bd0028a300a18fc Mon Sep 17 00:00:00 2001 From: lotyp Date: Wed, 11 Sep 2024 17:40:13 +0300 Subject: [PATCH] ci: updating docs and renovate bot config --- .github/CONTRIBUTING.md | 62 ++++++++++++++++++++++++------ .github/renovate.json | 10 +++++ src/Dockerfiles/base/Dockerfile.j2 | 2 +- 3 files changed, 62 insertions(+), 12 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1531b12..5cd184a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -47,17 +47,12 @@ Optional tools: ## 🚀 Quick Project Setup -1. Clone this repository: +Clone the repository: - ```bash - git clone git@github.com:wayofdev/docker-php-base.git && cd docker-php-base - ``` - -2. Install dependencies and set up the project: - - ```bash - make env install - ``` +```bash +git clone git@github.com:wayofdev/docker-php-base.git && \ +cd docker-php-base +```
@@ -182,7 +177,52 @@ We use various tools to maintain code quality: Run `make lint-yaml`, `make lint-docker`, and `make lint-ansible` to check your code. -Thank you for contributing to docker-php-base! +Here's a list of tools we use: + +### → Yaml Lint + +We use [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files. + +To lint yaml files run: + +```bash +make lint-yaml +``` + +by default, [`cytopia/yamllint`](https://github.com/cytopia/docker-yamllint) Docker image will be used to run linter. + +### → Action Lint + +We use [`actionlint`](https://github.com/rhysd/actionlint) to enforce coding standards in GitHub Actions workflows. + +To lint GitHub Actions run: + +```bash +make lint-actions +``` + +by default, [`rhysd/actionlint`](https://hub.docker.com/r/rhysd/actionlint/tags) Docker image will be used to run linter. + +### → Markdown Lint + +We use [`markdownlint-cli2`](https://github.com/davidanson/markdownlint-cli2) to enforce coding standards in Markdown files. + +To lint markdown files run: + +```bash +make lint-md-dry +make lint-md +``` + +### → Ansible Lint + +We use [`ansible-lint`](https://github.com/ansible/ansible-lint) to check Ansible playbooks for practices and behavior that could potentially be improved. + +To lint Ansible files, run: + +```bash +make lint-ansible +```
diff --git a/.github/renovate.json b/.github/renovate.json index 0e44fa8..00ecdef 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -4,6 +4,16 @@ "config:base", ":semanticCommitTypeAll(deps)" ], + "regexManagers": [ + { + "fileMatch": ["^src/inventory\\.yml$"], + "matchStrings": [ + "os_version:\\s*(?\\d+\\.\\d+)" + ], + "depNameTemplate": "alpine", + "datasourceTemplate": "docker" + } + ], "prHourlyLimit": 0, "automerge": true, "platformAutomerge": true, diff --git a/src/Dockerfiles/base/Dockerfile.j2 b/src/Dockerfiles/base/Dockerfile.j2 index 684b18e..9859a36 100644 --- a/src/Dockerfiles/base/Dockerfile.j2 +++ b/src/Dockerfiles/base/Dockerfile.j2 @@ -41,7 +41,7 @@ COPY --chown=www-data ./configs/php.ini /usr/local/etc/php/conf.d/php.ini RUN set -eux; \ apk -U upgrade -a \ {% if 'supervisord' == php_type %} - && apk add --no-cache supervisor=4.2.5-r5 \ + && apk add --no-cache supervisor \ {% endif %} && \ curl -sSLf \