Skip to content

Commit cbae69f

Browse files
committed
Add README file to document the current CI/CD configuration
1 parent 134f559 commit cbae69f

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

.github/README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# GitHub CI/CD Configuration
2+
3+
## Workflows
4+
5+
- `gradle.yaml`
6+
Build and checks (style, Javadoc)
7+
→ Trigger: push / PR on `trunk` and `release*`
8+
9+
- `codeql-analysis.yml`
10+
Security analysis (Java + JavaScript)
11+
→ Trigger: push / PR + weekly on `trunk` and `release*`
12+
13+
- `docker-image.yaml`
14+
Build and push images to `ghcr.io/apache/ofbiz`
15+
→ Trigger: push on `trunk` / `release*` + tags
16+
17+
- `dependency-review.yml`
18+
Vulnerability scanning for dependencies in PRs
19+
→ Trigger: all PRs
20+
21+
- `scorecard.yml`
22+
OpenSSF security scorecard
23+
→ Trigger: `trunk` + weekly
24+
25+
### Workflow behavior
26+
27+
- `push` → uses the workflow from the target branch
28+
- `pull_request` → uses the workflow from the source branch
29+
- `schedule` → always uses `trunk`
30+
31+
Workflows are maintained on all branches (`trunk` and `release*`) using the same triggers.
32+
33+
New branches inherit workflow files from `trunk` at creation time.
34+
35+
`scorecard.yml` runs only on `trunk` (default branch).
36+
37+
## Dependabot
38+
39+
Read **only from `trunk`**.
40+
41+
Updates:
42+
- GitHub Actions
43+
- Docker base images
44+
- NPM (`themes/common-theme/.../js`)
45+
46+
Each ecosystem includes:
47+
- one configuration for `trunk`
48+
- one configuration for each `release*` branch
49+
50+
## New release branch checklist
51+
52+
Before creating a new release branch from `trunk`, update `dependabot.yml` (on `trunk`) by adding a `target-branch` entry for:
53+
- npm
54+
- github-actions
55+
- docker
56+
57+
Then create the release branch.
58+
59+
Dependabot will automatically keep the new branch up to date.

0 commit comments

Comments
 (0)