Skip to content

Commit 27ee514

Browse files
authored
docs(README): add instruction for manual sync (#40)
2 parents 1a238db + b7d7c50 commit 27ee514

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

.github/workflows/generate-schema-gitguardian.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "Generate values.schema.json"
1+
name: "Generate values.schema.json GitGuardian"
22

33
on:
44
push:

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,27 @@
22
## Contribute
33

44
When improving our charts, it is necessary to contribute upstream on `Cloudpirates.io`.
5+
1. Set upstream URL with `git remote add upstream https://github.com/CloudPirates-io/helm-charts.git`
6+
2. Execute `./contrib.sh <new-branch>` script to start new contribution
7+
3. Cherry-pick your changes
8+
4. Create a new PR on upstream main branch
59

6-
1. Execute `./contrib.sh <new-branch>` script to start new contribution
7-
2. Cherry-pick your changes
8-
3. Create a new PR on upstream main branch
10+
## Manual sync
11+
12+
First ensure you enable merge policy by adding in your `.git/config` file:
13+
```
14+
[merge "theirs"]
15+
driver = true
16+
```
17+
This will apply the CHANGELOG.md merge policy defined in `.gitattributes`
18+
19+
1. Update upstream `git fetch upstream`
20+
2. Create sync branch `git checkout -b my-sync-branch`
21+
3. Check last X most recent commits that are on `upstream/main` but not yet on your branch `git log --pretty=format:'%h %ad %s' --date=short HEAD..upstream/main | tail -50`
22+
4. Merge target commit `git merge <sha>`
23+
5. Push to remote branch `git push origin my-sync-branch`
24+
25+
---
926

1027
<p align="center">
1128
<a href="https://artifacthub.io/packages/search?org=cloudpirates">

0 commit comments

Comments
 (0)