Skip to content

Commit d80f265

Browse files
committed
Add Guidelines on Branch Usage
1 parent e93c6d9 commit d80f265

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

CONTRIBUTING.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Contribution Guidelines
2+
3+
Development work for a given generation happens on the appropriate `releases/vX` branch.
4+
That is, if you are working on a maintenance release for the `1.0.x` generation, then make your commits on the `releases/v1` branch.
5+
Following that, perform a forward-merge to any subsequent `releases/vY` branches and finally to `main`.
6+
7+
If you are working on the next major, commit your changes to `main`.
8+
9+
When a version is released, it is merged from `releases/vX` to `vX`.
10+
This allows consumers of actions and workflows to use the `@v1` syntax whlie still having a stable usage experience.

RELEASE.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
= Release Guidelines
2+
3+
A release happens on the appropriate `releases/vX` branch.
4+
That is, when releasing `v1`, release from `releases/v1` using the "Build and Deploy" action.
5+
6+
Then forward-merge using `-s ours` from `releases/vX` to each subsequent `releases/vY` branch and finally `main`.
7+
When complete, merge the `releases/vX` branch into the `v1` branch.

0 commit comments

Comments
 (0)