Skip to content

Commit f3033b7

Browse files
committed
[Olympus] Add release guide for olympus
1 parent 884a77c commit f3033b7

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

RELEASE_GUIDE_OLYMPUS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Filament Release Guide
2+
3+
- $VERSION = the current version that has been released (e.g. 1.10.7)
4+
- $NEXT_VERSION = the next version we plan to release (e.g. 1.10.8)
5+
- $PATCH_VERSION = the minor version on top of filament version (e.g. 1.10.7-__p0__)
6+
7+
## Release a new filament version for olympus
8+
9+
### 1. keep track of our changes in the current release
10+
11+
- compare the current olympus release branch `elisemorysc/filament:olympus-$VERSION` with the upstream filament release `google/filament:v$VERSION` (e.g. https://github.com/google/filament/compare/v1.10.7...elisemorysc:olympus-1.10.7)
12+
- we should see the hunterization commit marked `[Hunter]`
13+
- we should see the olympus changes marked `[Olympus]`
14+
15+
### 2. create new release branch
16+
17+
- create a new branch `elisemorysc/filament:olympus-$NEXT_VERSION` from the upstream filament version (e.g. `google/filament:v1.10.8` -> `elisemorysc/filament:olympus-1.10.8`)
18+
- cherry pick in our changes from the last step
19+
- solve any conflicts
20+
21+
### 3. cut new release
22+
23+
- cut a new release `olympus-$NEXT_VERSION-$PATH_VERSION` (e.g. `olympus-1.10.8-p0`) from the new branch
24+
25+
## Release a new filament version for hunter
26+
27+
- create a new branch `elisemorysc/filament:hunter-$NEXT_VERSION` from the upstream filament version (e.g. `google/filament:v1.10.8` -> `elisemorysc/filament:hunter-1.10.8`)
28+
- cherry pick in the hunterization commit marked `[Hunter]` from the current olympus release `elisemorysc/filament:olympus-$VERSION`
29+
- solve any conflicts
30+
- put up a PR against the hunter repo for filament `cpp-pm/filament:hunter-$NEXT_VERSION`

0 commit comments

Comments
 (0)