Skip to content

Commit 57ca51e

Browse files
authored
Merge pull request #85 from wayofdev/ci/structure-updates
ci: updating docs and renovate bot config
2 parents 15540ad + ed83040 commit 57ca51e

File tree

3 files changed

+62
-12
lines changed

3 files changed

+62
-12
lines changed

.github/CONTRIBUTING.md

+51-11
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,12 @@ Optional tools:
4747

4848
## 🚀 Quick Project Setup
4949

50-
1. Clone this repository:
50+
Clone the repository:
5151

52-
```bash
53-
git clone [email protected]:wayofdev/docker-php-base.git && cd docker-php-base
54-
```
55-
56-
2. Install dependencies and set up the project:
57-
58-
```bash
59-
make env install
60-
```
52+
```bash
53+
git clone [email protected]:wayofdev/docker-php-base.git && \
54+
cd docker-php-base
55+
```
6156

6257
<br>
6358

@@ -182,7 +177,52 @@ We use various tools to maintain code quality:
182177

183178
Run `make lint-yaml`, `make lint-docker`, and `make lint-ansible` to check your code.
184179

185-
Thank you for contributing to docker-php-base!
180+
Here's a list of tools we use:
181+
182+
### → Yaml Lint
183+
184+
We use [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files.
185+
186+
To lint yaml files run:
187+
188+
```bash
189+
make lint-yaml
190+
```
191+
192+
by default, [`cytopia/yamllint`](https://github.com/cytopia/docker-yamllint) Docker image will be used to run linter.
193+
194+
### → Action Lint
195+
196+
We use [`actionlint`](https://github.com/rhysd/actionlint) to enforce coding standards in GitHub Actions workflows.
197+
198+
To lint GitHub Actions run:
199+
200+
```bash
201+
make lint-actions
202+
```
203+
204+
by default, [`rhysd/actionlint`](https://hub.docker.com/r/rhysd/actionlint/tags) Docker image will be used to run linter.
205+
206+
### → Markdown Lint
207+
208+
We use [`markdownlint-cli2`](https://github.com/davidanson/markdownlint-cli2) to enforce coding standards in Markdown files.
209+
210+
To lint markdown files run:
211+
212+
```bash
213+
make lint-md-dry
214+
make lint-md
215+
```
216+
217+
### → Ansible Lint
218+
219+
We use [`ansible-lint`](https://github.com/ansible/ansible-lint) to check Ansible playbooks for practices and behavior that could potentially be improved.
220+
221+
To lint Ansible files, run:
222+
223+
```bash
224+
make lint-ansible
225+
```
186226

187227
<br>
188228

.github/renovate.json

+10
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
"config:base",
55
":semanticCommitTypeAll(deps)"
66
],
7+
"regexManagers": [
8+
{
9+
"fileMatch": ["^src/inventory\\.yml$"],
10+
"matchStrings": [
11+
"os_version:\\s*(?<currentValue>\\d+\\.\\d+)"
12+
],
13+
"depNameTemplate": "alpine",
14+
"datasourceTemplate": "docker"
15+
}
16+
],
717
"prHourlyLimit": 0,
818
"automerge": true,
919
"platformAutomerge": true,

src/Dockerfiles/base/Dockerfile.j2

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ COPY --chown=www-data ./configs/php.ini /usr/local/etc/php/conf.d/php.ini
4141
RUN set -eux; \
4242
apk -U upgrade -a \
4343
{% if 'supervisord' == php_type %}
44-
&& apk add --no-cache supervisor=4.2.5-r5 \
44+
&& apk add --no-cache supervisor \
4545
{% endif %}
4646
&& \
4747
curl -sSLf \

0 commit comments

Comments
 (0)