Skip to content

Commit dbd517c

Browse files
lotyplotyp
committed
docs: add guidelines
1 parent 8e40f30 commit dbd517c

File tree

12 files changed

+768
-23
lines changed

12 files changed

+768
-23
lines changed

‎.cursor/renovate-guidelines.md‎

Lines changed: 640 additions & 0 deletions
Large diffs are not rendered by default.

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
22

3-
* @lotyp @jevgenijsblaus
3+
* @lotyp

‎.markdownlint.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.34.0/schema/markdownlint-config-schema.json",
2+
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.38.0/schema/markdownlint-config-schema.json",
33
"line-length": false,
44
"no-inline-html": false,
55
"first-line-h1": false

‎.pre-commit-config.yaml‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,29 @@ repos:
77
- id: trailing-whitespace
88
- id: end-of-file-fixer
99
- id: check-added-large-files
10-
- id: fix-encoding-pragma
10+
- id: check-yaml
11+
- id: check-json
12+
- id: check-merge-conflict
13+
- id: check-case-conflict
14+
- id: mixed-line-ending
1115

1216
- repo: https://github.com/commitizen-tools/commitizen
13-
rev: v4.7.1
17+
rev: v4.8.3
1418
hooks:
1519
- id: commitizen
1620
stages:
1721
- commit-msg
1822

1923
- repo: https://github.com/mpalmer/action-validator
20-
rev: v0.6.0
24+
rev: v0.7.1
2125
hooks:
2226
- id: action-validator
23-
stages:
24-
- commit-msg
27+
28+
- repo: https://github.com/adrienverge/yamllint
29+
rev: v1.37.1
30+
hooks:
31+
- id: yamllint
32+
args: [-c=.yamllint.yaml]
2533

2634
- repo: local
2735
hooks:

‎.yamllint.yaml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
extends: default
44

55
ignore: |
6-
node_modules/
76
assets/
8-
pnpm-lock.yaml
97
108
rules:
119
braces:

‎Makefile‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ MARKDOWN_LINT_RUNNER ?= $(DOCKER) run --rm $$(tty -s && echo "-it" || echo) \
1717
--workdir /app \
1818
davidanson/markdownlint-cli2-rules:latest
1919

20+
RENOVATE_RUNNER ?= $(DOCKER) run --rm $$(tty -s && echo "-it" || echo) \
21+
-v $(shell pwd):/usr/src/app \
22+
--workdir /usr/src/app \
23+
renovate/renovate:latest
24+
2025
#
2126
# Self documenting Makefile code
2227
# ------------------------------------------------------------------------------------
@@ -78,7 +83,7 @@ hooks: ## Install git hooks from pre-commit-config
7883
pre-commit autoupdate
7984
.PHONY: hooks
8085

81-
lint: lint-yaml lint-actions lint-md ## Lint all files
86+
lint: lint-yaml lint-actions lint-md lint-renovate ## Lint all files
8287
.PHONY: lint
8388

8489
lint-yaml: ## Lint all yaml files
@@ -97,6 +102,24 @@ lint-md-dry: ## Lint all markdown files using markdownlint-cli2 in dry-run mode
97102
@$(MARKDOWN_LINT_RUNNER) "**/*.md" "#CHANGELOG.md" | tee -a $(MAKE_LOGFILE)
98103
.PHONY: lint-md-dry
99104

105+
lint-renovate: ## Validate renovate configuration
106+
@echo "${GREEN}🤖 Validating renovate.json5 configuration...${RST}"
107+
@$(RENOVATE_RUNNER) renovate-config-validator renovate.json5 | tee -a $(MAKE_LOGFILE)
108+
.PHONY: lint-renovate
109+
110+
renovate-dry-run: ## Run renovate in dry-run mode (requires GITHUB_TOKEN)
111+
@echo "${GREEN}🤖 Running renovate in dry-run mode...${RST}"
112+
@if [ -z "$(GITHUB_TOKEN)" ]; then \
113+
echo "${RED}❌ Error: GITHUB_TOKEN environment variable is required${RST}"; \
114+
echo "${YELLOW}💡 Set it with: export GITHUB_TOKEN=your_token_here${RST}"; \
115+
exit 1; \
116+
fi
117+
@$(RENOVATE_RUNNER) \
118+
-e GITHUB_TOKEN="$(GITHUB_TOKEN)" \
119+
-e LOG_LEVEL=info \
120+
renovate --dry-run --print-config | tee -a $(MAKE_LOGFILE)
121+
.PHONY: renovate-dry-run
122+
100123
#
101124
# Release
102125
# ------------------------------------------------------------------------------------

‎README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@
99
<br>
1010
<br>
1111
</div>
12-
1312
<div align="center">
14-
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fwayofdev%2Fgh-actions%2Fbadge&style=flat-square&label=github%20actions"/></a>
13+
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/wayofdev/gh-actions/release.yml?branch=master&style=flat-square&label=github%20actions"/></a>
1514
<a href="https://github.com/wayofdev/gh-actions" target="_blank"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/gh-actions/latest?style=flat-square"></a>
1615
<a href="https://discord.gg/CE3TcCC5vr" target="_blank"><img alt="Codecov" src="https://img.shields.io/discord/1228506758562058391?style=flat-square&logo=discord&labelColor=7289d9&logoColor=white&color=39456d"></a>
1716
<a href="https://x.com/intent/follow?screen_name=wayofdev" target="_blank"><img alt="Follow on Twitter (X)" src="https://img.shields.io/badge/-Follow-black?style=flat-square&logo=X"></a>
@@ -395,7 +394,7 @@ Thank you for considering contributing to the wayofdev community! We are open to
395394
- 🤔 [Suggest a feature](https://github.com/wayofdev/gh-actions/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+)
396395
- 🐛 [Report an issue](https://github.com/wayofdev/gh-actions/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+)
397396
- 📖 [Improve documentation](https://github.com/wayofdev/gh-actions/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+)
398-
- 👨‍💻 Contribute to the code
397+
- 👨‍💻 [Contribute to the code](.github/CONTRIBUTING.md)
399398

400399
You are more than welcome. Before contributing, kindly check our [contribution guidelines](.github/CONTRIBUTING.md).
401400

‎actions/composer/get-cache-directory/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
</div>
1212

1313
<div align="center">
14-
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fwayofdev%2Fgh-actions%2Fbadge&style=flat-square&label=github%20actions"/></a>
14+
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/wayofdev/gh-actions/release.yml?branch=master&style=flat-square&label=github%20actions"/></a>
1515
<a href="https://github.com/wayofdev/gh-actions" target="_blank"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/gh-actions/latest?style=flat-square"></a>
1616
<a href="https://discord.gg/CE3TcCC5vr" target="_blank"><img alt="Codecov" src="https://img.shields.io/discord/1228506758562058391?style=flat-square&logo=discord&labelColor=7289d9&logoColor=white&color=39456d"></a>
1717
<a href="https://x.com/intent/follow?screen_name=wayofdev" target="_blank"><img alt="Follow on Twitter (X)" src="https://img.shields.io/badge/-Follow-black?style=flat-square&logo=X"></a>

‎actions/composer/get-root-version/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
</div>
1212

1313
<div align="center">
14-
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fwayofdev%2Fgh-actions%2Fbadge&style=flat-square&label=github%20actions"/></a>
14+
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/wayofdev/gh-actions/release.yml?branch=master&style=flat-square&label=github%20actions"/></a>
1515
<a href="https://github.com/wayofdev/gh-actions" target="_blank"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/gh-actions/latest?style=flat-square"></a>
1616
<a href="https://discord.gg/CE3TcCC5vr" target="_blank"><img alt="Codecov" src="https://img.shields.io/discord/1228506758562058391?style=flat-square&logo=discord&labelColor=7289d9&logoColor=white&color=39456d"></a>
1717
<a href="https://x.com/intent/follow?screen_name=wayofdev" target="_blank"><img alt="Follow on Twitter (X)" src="https://img.shields.io/badge/-Follow-black?style=flat-square&logo=X"></a>

‎actions/composer/install/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
</div>
1212

1313
<div align="center">
14-
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fwayofdev%2Fgh-actions%2Fbadge&style=flat-square&label=github%20actions"/></a>
14+
<a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/wayofdev/gh-actions/release.yml?branch=master&style=flat-square&label=github%20actions"/></a>
1515
<a href="https://github.com/wayofdev/gh-actions" target="_blank"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/gh-actions/latest?style=flat-square"></a>
1616
<a href="https://discord.gg/CE3TcCC5vr" target="_blank"><img alt="Codecov" src="https://img.shields.io/discord/1228506758562058391?style=flat-square&logo=discord&labelColor=7289d9&logoColor=white&color=39456d"></a>
1717
<a href="https://x.com/intent/follow?screen_name=wayofdev" target="_blank"><img alt="Follow on Twitter (X)" src="https://img.shields.io/badge/-Follow-black?style=flat-square&logo=X"></a>

0 commit comments

Comments
 (0)