Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: updating docs and renovate bot config #85

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 51 additions & 11 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<br>

Expand Down Expand Up @@ -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
```

<br>

Expand Down
10 changes: 10 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@
"config:base",
":semanticCommitTypeAll(deps)"
],
"regexManagers": [
{
"fileMatch": ["^src/inventory\\.yml$"],
"matchStrings": [
"os_version:\\s*(?<currentValue>\\d+\\.\\d+)"
],
"depNameTemplate": "alpine",
"datasourceTemplate": "docker"
}
],
"prHourlyLimit": 0,
"automerge": true,
"platformAutomerge": true,
Expand Down
2 changes: 1 addition & 1 deletion src/Dockerfiles/base/Dockerfile.j2
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down