Skip to content

Commit 4d13976

Browse files
committed
docs: update README-eyevinn
Signed-off-by: Gustav Grusell <[email protected]>
1 parent 1efd28f commit 4d13976

File tree

1 file changed

+30
-25
lines changed

1 file changed

+30
-25
lines changed

README-eyevinn.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,51 +14,56 @@ For information on changes in this fork compare to upstream, see [Releasenotes](
1414
The master branch tracks the upstream master. No development should be done on this branch.
1515

1616
### Release branches
17-
This fork uses release branches, where each version a.b.c from upstream forms the basis for a branch
18-
`release-a.b.c` in this repository. New features/PR should be developed on the latest release branch.
17+
This fork uses release branches, where the active release branch, based on the latest
18+
version from upstreadm, is the `release` branch.
19+
Older release branches based on earlier upstream versions are named `release-a.b.c` where
20+
a.b.c is the upstream version the branch is based on.
21+
New features/PR should be developed on the `release` branch.
1922

2023
### Release versioning
21-
Releases in this repo follows a versioning scheme `a.b.c-d` where `a.b.c` would be the version of the
22-
current upstream release, and `d` would start at 1 for each release branch and then be incremented
24+
Releases in this repo follows a versioning scheme `a.b.c-d` where `a.b.c` would be the version of the upstream release,
25+
and `d` would start at 1 for each release branch and then be incremented
2326
by one for each release from that branch.
2427

2528
## Creating a new release
2629
1. Make sure all changes for the release are merged into the release branch
2730
2. Run `./gradlew clean build` to make sure everything builds correctly
28-
3. Tag the head of the release branch with the new version `a.b.c-d` (See [Release versioning](#release-versioning) above)
29-
4. Push the tag to the remote repository. The project will be built and a release created automatically.
30-
5. Edit the description of the release on GitHub to include relevant information about the release.
31+
3. Updated the `RELEASENOTES-eyevinn.md` file to include relevant information about the release.
32+
4. Tag the head of the release branch with the new version `x.y.z-d` (See [Release versioning](#release-versioning) above)
33+
5. Push the tag to the remote repository. The project will be built and a release created automatically.
34+
6. Edit the description of the release on GitHub to include relevant information about the release.
3135

3236
## Keeping in sync with upstream
33-
When a new version is released in the upstream repository, new release branch based on the latest upstream release
34-
should be created. This release branch should include all changes from the previous release branch that are not
35-
included in the new upstream release. This can be done either by using `git rebase` or `git cherry-pick`,
36-
both methods are describe below.
37+
When a new version is released in the upstream repository, a branch `release-a.b.c` (where a.b.c is the previous
38+
release version) should be created off of the current `release` branch. The `release` branch should then be updated
39+
to track the new upstream release, and should include any changes from the previous release
40+
that are not included in the new release. This can be done either by using `git rebase` or `git cherry-pick`.
41+
Both methods are describe below, git rebase is the preferred method.
3742

43+
### New release branch with `git rebase` (for new upstream version x.y.z)
44+
1. Pull the changes from upstream into this repositories `master` branch.
45+
2. Create a new branch `release-a.b.c` off of `release` where `a.b.c` is the **previous** upstream release version.
46+
3. Use `git rebase` to rebase `release` branch onto `master`.
47+
4. Push the `release` branch to the remote repository `git push -f`.
48+
5. Create a new release `vx.y.z-1`. from teh `release` branch.
3849

39-
### New release branch with `git cherry-pick`
50+
### New release branch with `git cherry-pick` (for new upstream version x.y.z)
4051
1. Pull the changes from upstream into this repositories `master` branch.
41-
2. Create a new branch off of `master` called `release-a.b.c`, where `a.b.c` is the
42-
new upstream release version.
43-
3. Use `git cherry-pick` to transfer all changes from the previous release branch that are not included
52+
2. Create a new branch `release-a.b.c` off of `release` where `a.b.c` is the **previous** upstream release version.
53+
3. Reset `release` to point to master: `git reset --hard master`. _**Warning: this is a destructive operation, so
54+
make sure you have performed the previous step first to preserve the previous release branch**_
55+
4. Use `git cherry-pick` to transfer all changes from the previous release branch `release-a.b.c` that are not included
4456
in the new upstrem release to the new release branch
45-
4. Create a new release `va.b.c-1`.
46-
5. Update repository setting so that new branch is the default branch
57+
5. Push the `release` branch to the remote repository `git push -f`.
58+
6. Create a new release `vx.y.z-1` from the `release` branch.
4759

48-
### New release branch with `git rebase`
49-
1. Pull the changes from upstream into this repositories `master` branch.
50-
2. Create a new branch off of the previous release branch called `release-a.b.c`, where `a.b.c` is the
51-
new upstream release version.
52-
3. Use `git rebase` to reabse the new release branch onto `master`.
53-
4. Create a new release `va.b.c-1`.
54-
5. Update repository setting so that new branch is the default branch
5560

5661
## Contributing to this fork
5762
To contribute a new feature, bug fix etc based on this repository, follow the steps below.
5863
Breaking changes, and changes to default behaviour should be avoided if possible.
5964
Also see the [general contribution guidelines](CONTRIBUTING.adoc).
6065

61-
1. Create a branch from the lastest release branch
66+
1. Create a branch from the `release` branch
6267
2. Implement your changes
6368
3. Unless there is a specific reason not to, squash your changes into a single commit
6469
4. Make sure your commit messages are in accordance with the [general contribution guidelines](CONTRIBUTING.adoc),

0 commit comments

Comments
 (0)