Skip to content

Commit 2307f89

Browse files
lotyplotyp
committed
style: fix coding standards
1 parent b23fd25 commit 2307f89

File tree

4 files changed

+81
-57
lines changed

4 files changed

+81
-57
lines changed

‎.github/CONTRIBUTING.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Welcome to the docker-php-base project!
3+
Welcome to the docker-nginx project!
44

55
We appreciate your interest in contributing. This guide will help you get started, ensuring an effective collaboration.
66

@@ -50,8 +50,8 @@ Optional tools:
5050
Clone the repository:
5151

5252
```bash
53-
git clone [email protected]:wayofdev/docker-php-base.git && \
54-
cd docker-php-base
53+
git clone [email protected]:wayofdev/docker-nginx.git && \
54+
cd docker-nginx
5555
```
5656

5757
<br>
@@ -113,17 +113,17 @@ make test
113113

114114
Our project employs [GitHub Actions](https://github.com/features/actions) for continuous integration, ensuring code quality and reliability. We encourage contributors to review our workflow configurations to understand the CI processes:
115115

116-
| Workflow | Description |
117-
|--------------------------------------------------------------|---------------------------------------------------------------------|
118-
| [`apply-labels.yml`](workflows/apply-labels.yml) | Auto labels PRs based on rules. |
119-
| [`auto-merge-release.yml`](workflows/auto-merge-release.yml) | Automatically merges release PRs. |
120-
| [`build.yml`](workflows/build.yml) | Builds Docker images. |
121-
| [`coding-standards.yml`](workflows/coding-standards.yml) | Checks `yaml`, `md`, `composer`, `php` and commit coding standards. |
122-
| [`create-release.yml`](workflows/create-release.yml) | Creates a release on GitHub. |
123-
| [`merge.yml`](workflows/merge.yml) | Automatically merges PRs. |
124-
| [`shellcheck.yml`](workflows/shellcheck.yml) | Checks shell scripts. |
125-
| [`test.yml`](workflows/test.yml) | Runs tests on Docker images. |
126-
| [`upload-assets.yml`](workflows/upload-assets.yml) | Uploads dist assets to GitHub releases. |
116+
| Workflow | Description |
117+
|--------------------------------------------------------------|--------------------------------------------------------------|
118+
| [`apply-labels.yml`](workflows/apply-labels.yml) | Auto labels PRs based on rules. |
119+
| [`auto-merge-release.yml`](workflows/auto-merge-release.yml) | Automatically merges release PRs. |
120+
| [`build.yml`](workflows/build.yml) | Builds Docker images. |
121+
| [`coding-standards.yml`](workflows/coding-standards.yml) | Checks `yaml`, `md`, `composer` and commit coding standards. |
122+
| [`create-release.yml`](workflows/create-release.yml) | Creates a release on GitHub. |
123+
| [`merge.yml`](workflows/merge.yml) | Automatically merges PRs. |
124+
| [`shellcheck.yml`](workflows/shellcheck.yml) | Checks shell scripts. |
125+
| [`test.yml`](workflows/test.yml) | Runs tests on Docker images. |
126+
| [`upload-assets.yml`](workflows/upload-assets.yml) | Uploads dist assets to GitHub releases. |
127127

128128
<br>
129129

@@ -314,12 +314,12 @@ Our pre-commit configuration includes several hooks:
314314
* **Action Validator**: Validates GitHub Actions workflow files.
315315
* **Ansible Lint**: Checks Ansible playbooks for practices and behavior that could potentially be improved.
316316
* **Ansible Role Checks**: Several hooks to find issues in Ansible roles:
317-
* Find unused variables
318-
* Find empty files
319-
* Find empty directories
320-
* Fix readability issues
321-
* Find undefined handlers
322-
* Find unquoted values
317+
* Find unused variables
318+
* Find empty files
319+
* Find empty directories
320+
* Fix readability issues
321+
* Find undefined handlers
322+
* Find unquoted values
323323

324324
These hooks help maintain code quality, consistency, and prevent common issues before they are committed to the repository.
325325

‎README.md

+52-30
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<br>
2-
3-
<div align="center">
4-
<img alt="Logo" width="456" src="https://raw.githubusercontent.com/wayofdev/docker-nginx/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only">
5-
<img alt="Logo" width="456" src="https://raw.githubusercontent.com/wayofdev/docker-nginx/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only">
6-
</div>
7-
8-
<br>
9-
10-
<br>
1+
<p align="center">
2+
<br>
3+
<a href="https://wayof.dev" target="_blank">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/wayofdev/.github/master/assets/logo.gh-dark-mode-only.png">
6+
<img width="400" src="https://raw.githubusercontent.com/wayofdev/.github/master/assets/logo.gh-light-mode-only.png" alt="WayOfDev Logo">
7+
</picture>
8+
</a>
9+
<br>
10+
</p>
1111

1212
<div align="center">
1313
<a href="https://actions-badge.atrox.dev/wayofdev/docker-nginx/goto"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fwayofdev%2Fdocker-nginx%2Fbadge&style=flat-square"/></a>
@@ -40,30 +40,30 @@ For testing purposes we use **goss** and **dgoss**, follow installation instruct
4040
Generating distributable Dockerfiles from yaml source code:
4141

4242
```bash
43-
$ make generate
43+
make generate
4444
```
4545

4646
<br>
4747

4848
Building default image:
4949

5050
```bash
51-
$ git clone [email protected]:wayofdev/docker-nginx.git
52-
$ cd docker-nginx
53-
$ make build
51+
git clone [email protected]:wayofdev/docker-nginx.git
52+
cd docker-nginx
53+
make build
5454
```
5555

5656
To **build** image, **test** it and then **clean** temporary files run:
5757

5858
```bash
59-
$ make
59+
make
6060
```
6161

6262
Building all images:
6363

6464
```bash
65-
$ make build IMAGE_TEMPLATE=dev-alpine
66-
$ make build IMAGE_TEMPLATE=k8s-alpine
65+
make build IMAGE_TEMPLATE=dev-alpine
66+
make build IMAGE_TEMPLATE=k8s-alpine
6767
```
6868

6969
<br>
@@ -73,14 +73,14 @@ $ make build IMAGE_TEMPLATE=k8s-alpine
7373
Testing default image:
7474

7575
```bash
76-
$ make test
76+
make test
7777
```
7878

7979
To test all images:
8080

8181
```bash
82-
$ make test IMAGE_TEMPLATE=dev-alpine
83-
$ make test IMAGE_TEMPLATE=k8s-alpine
82+
make test IMAGE_TEMPLATE=dev-alpine
83+
make test IMAGE_TEMPLATE=k8s-alpine
8484
```
8585

8686
<br>
@@ -90,41 +90,63 @@ $ make test IMAGE_TEMPLATE=k8s-alpine
9090
Run **yamllint** to validate all yaml files in project:
9191

9292
```bash
93-
$ make lint-yaml
93+
make lint-yaml
9494
```
9595

9696
Run hadolint to validate created Dockerfiles:
9797

9898
```bash
99-
$ make lint-docker
99+
make lint-docker
100100
```
101101

102102
Run ansible-lint to validate project files:
103103

104104
```bash
105-
$ make lint-ansible
105+
make lint-ansible
106106
```
107107

108108
<br>
109109

110-
## 🤝 License
110+
## 🔒 Security Policy
111111

112-
[![Licence](https://img.shields.io/github/license/wayofdev/docker-nginx?style=for-the-badge&color=blue)](./LICENSE)
112+
This project has a [security policy](.github/SECURITY.md).
113113

114114
<br>
115115

116-
## 🙆🏼‍♂️ Author Information
116+
## 🙌 Want to Contribute?
117+
118+
Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:
119+
120+
- 🤔 [Suggest a feature](https://github.com/wayofdev/docker-nginx/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+)
121+
- 🐛 [Report an issue](https://github.com/wayofdev/docker-nginx/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+)
122+
- 📖 [Improve documentation](https://github.com/wayofdev/docker-nginx/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+)
123+
- 👨‍💻 [Contribute to the code](./.github/CONTRIBUTING.md)
117124

118-
This repository was created in **2022** by [lotyp / wayofdev](https://github.com/wayofdev).
125+
You are more than welcome. Before contributing, kindly check our [contribution guidelines](.github/CONTRIBUTING.md).
126+
127+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org)
119128

120129
<br>
121130

122131
## 🫡 Contributors
123132

124-
<img align="left" src="https://img.shields.io/github/contributors-anon/wayofdev/docker-nginx?style=for-the-badge"/>
125-
133+
<p align="left">
126134
<a href="https://github.com/wayofdev/docker-nginx/graphs/contributors">
127-
<img src="https://opencollective.com/wod/contributors.svg?width=890&button=false" alt="Supporters">
135+
<img align="left" src="https://img.shields.io/github/contributors-anon/wayofdev/docker-nginx?style=for-the-badge" alt="Contributors Badge"/>
128136
</a>
137+
<br>
138+
<br>
139+
</p>
140+
141+
## 🌐 Social Links
142+
143+
- **Twitter:** Follow our organization [@wayofdev](https://twitter.com/intent/follow?screen_name=wayofdev) and the author [@wlotyp](https://twitter.com/intent/follow?screen_name=wlotyp).
144+
- **Discord:** Join our community on [Discord](https://discord.gg/CE3TcCC5vr).
145+
146+
<br>
147+
148+
## ⚖️ License
149+
150+
[![Licence](https://img.shields.io/github/license/wayofdev/docker-nginx?style=for-the-badge&color=blue)](./LICENSE.md)
129151

130152
<br>

‎src/playbook.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22

3-
- hosts: all
3+
- name: Generate nginx Dockerfiles
4+
hosts: all
45
gather_facts: false
56
tags:
67
- template
78
tasks:
8-
- import_tasks: roles/all/main.yml
9+
- name: Create dist for all supported nginx versions
10+
ansible.builtin.import_tasks: roles/all/main.yml
911

1012
...

‎src/roles/all/main.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
file:
1717
path: "{{ item.path }}"
1818
state: directory
19-
mode: 0775
19+
mode: "0775"
2020
recurse: true
2121
with_items:
2222
- "{{ tpl_directories }}"
@@ -26,7 +26,7 @@
2626
src: "{{ item.src }}"
2727
dest: "{{ item.dst }}"
2828
force: true
29-
mode: 0644
29+
mode: "0644"
3030
with_items:
3131
- "{{ tpl_dockerfiles }}"
3232

@@ -35,7 +35,7 @@
3535
src: "{{ item.src }}"
3636
dest: "{{ item.dst }}"
3737
force: true
38-
mode: 0644
38+
mode: "0644"
3939
with_items:
4040
- "{{ tpl_configs }}"
4141

@@ -44,7 +44,7 @@
4444
src: "{{ item.src }}"
4545
dest: "{{ item.dst }}"
4646
force: true
47-
mode: 0644
47+
mode: " 0644"
4848
with_items:
4949
- "{{ tpl_docker_tests }}"
5050

@@ -53,7 +53,7 @@
5353
src: "{{ item.src }}"
5454
dest: "{{ item.dst }}"
5555
force: true
56-
mode: 0644
56+
mode: "0644"
5757
with_items:
5858
- "{{ tpl_certs }}"
5959

0 commit comments

Comments
 (0)