You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(changelog): add git-cliff and make changelog to documentation
Update all make target references, OpenClaw/agent prompts, standards
pages, container docs, and retrofit guide with new changelog target.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: content/docs/getting-started/agents.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,6 +68,7 @@ If you do not want to commit DevRail files yet, you can paste instructions direc
68
68
> -`make format` -- check formatting
69
69
> -`make test` -- run tests
70
70
> -`make security` -- run security scanners
71
+
> -`make changelog` -- generate CHANGELOG.md from conventional commits
71
72
> -`make check` -- run everything
72
73
>
73
74
> Languages are declared in `.devrail.yml`. The Makefile reads this file to determine which tools to run. See https://devrail.dev/docs/standards/ for per-language tool details.
@@ -162,6 +163,7 @@ the retrofit guide at: https://devrail.dev/docs/getting-started/retrofit/
162
163
- `make test` — run tests
163
164
- `make security` — run security scanners
164
165
- `make scan` — run trivy + gitleaks
166
+
- `make changelog` — generate CHANGELOG.md from conventional commits
Copy file name to clipboardExpand all lines: content/docs/standards/universal.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,18 @@
2
2
title: "Universal Security"
3
3
linkTitle: "Universal Security"
4
4
weight: 50
5
-
description: "Universal security tools that run for every project: trivyand gitleaks."
5
+
description: "Universal tools that run for every project: trivy, gitleaks, and git-cliff."
6
6
---
7
7
8
-
These tools run for every DevRail-managed project regardless of declared languages. They provide baseline vulnerability scanning and secret detection.
8
+
These tools run for every DevRail-managed project regardless of declared languages. They provide baseline vulnerability scanning, secret detection, and changelog generation.
All tools are pre-installed in the dev-toolchain container. Do not install them on the host.
18
19
@@ -55,13 +56,22 @@ Recommended `.gitleaks.toml`:
55
56
56
57
gitleaks detects secrets (API keys, tokens, passwords) in git history and staged changes. Use the allowlist only for verified false positives.
57
58
59
+
### git-cliff
60
+
61
+
Config file: `cliff.toml` at repository root. The DevRail templates include a default configuration that groups commits by conventional commit type.
62
+
63
+
git-cliff reads your git log and generates a `CHANGELOG.md` following the [Keep a Changelog](https://keepachangelog.com/) format. It requires conventional commit messages to produce meaningful output.
64
+
65
+
Run `make changelog` to regenerate the changelog from the full commit history.
|`make scan`|`gitleaks detect --source .`| Secret detection in repository |
74
+
|`make changelog`|`git-cliff -o CHANGELOG.md`| Generate changelog from conventional commits |
65
75
66
76
The `make scan` target is separate from `make security`. The `security` target runs language-specific scanners (bandit, tfsec, etc.), while `scan` runs universal scanners that apply to all projects.
67
77
@@ -91,4 +101,5 @@ repos:
91
101
- **gitleaks runs both locally and in CI.** The local pre-commit hook catches secrets immediately; CI provides a final safety net.
92
102
- **Findings at any severity level cause a non-zero exit code.** Do not suppress findings without explicit justification in `.trivyignore` or `.gitleaks.toml` allowlist.
93
103
- **Both tools produce JSON output in CI** for artifact collection and reporting.
104
+
- **`git-cliff` runs as part of `make changelog`**, which is separate from both `make scan` and `make check`. It generates a `CHANGELOG.md` from conventional commits and requires a `cliff.toml` configuration file.
94
105
- **All tools are pre-installed in the dev-toolchain container.** Do not install them on the host.
0 commit comments