Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,11 @@ Have ideas for new features or use cases? We're eager to hear them! But first:

## Branch model

This repo uses a branch-per-major release model. There is no `main`.

- **`v1`** — current stable major. PRs for bug fixes / non-breaking features target this branch. Releases are cut from here (see `scripts/release.sh`).
- **`v<next>-dev`** — when a major bump is in progress (e.g. `v2-dev`), this branch is open for the new major's work. PRs introducing breaking changes target this branch, not `v1`.
- **Older majors** (`v0`, etc.) stay on the repo for back-ports and security patches. Default branch on github.com is whichever major is current stable.

When you fork or clone, the default branch is `v1` today. If you have a `main` branch from a previous checkout, delete it locally:

```sh
git checkout v1
git branch -D main
git remote prune origin
```
See [docs/BRANCHING.md](docs/BRANCHING.md) for the current release-train model.
In short: independently releasable work may target the stable branch directly;
multi-feature or cross-repo train work uses the active `*-dev` integration
branch and is promoted to the matching stable branch when ready. `main` is only
the default/static GitHub branch.

## Releases

Expand Down Expand Up @@ -106,4 +98,4 @@ Connect with the GenLayer community to discuss, collaborate, and share insights:
- **[Discord Channel](https://discord.gg/8Jm4v89VAu)**: Our primary hub for discussions, support, and announcements.
- **[Telegram Group](https://t.me/genlayer)**: For more informal chats and quick updates.

Your continuous feedback drives better product development. Please engage with us regularly to test, discuss, and improve the GenLayerJS SDK.
Your continuous feedback drives better product development. Please engage with us regularly to test, discuss, and improve the GenLayerJS SDK.
58 changes: 58 additions & 0 deletions docs/BRANCHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Branching and Release Trains

This repo follows the GenLayer release-train model.

## Current Train

- Current stable branch: `v1`
- Active integration branch: `v2-dev`
- Next stable target: `v2`
- `main`: default/static branch alias for the active integration branch

## Stable Branches

Stable branches are long-lived release lines. They are named after the version
line they ship, for example `v1` or `v2`.

PRs may target a stable branch directly when the merged result should be
releasable immediately. This is appropriate for bug fixes, small non-breaking
features, isolated release fixes, or a breaking change that is intentionally
shipping as the next version by itself.

Stable branches must remain releasable. PRs into stable branches are expected to
pass the required cross-repo `E2E Tests` gate before merge.

## Integration Branches

Integration branches are optional. Use one when multiple changes need to
accumulate before release, especially for cross-repo work, dependent features,
breaking changes that must ship together, or a train that needs advisory E2E
while still expected to be red.

Integration branches are named after the target stable branch plus `-dev`, for
example `v2-dev`. Feature PRs for that train target the integration branch.

PRs into integration branches may run `E2E Tests` as advisory checks. They are
not the release gate.

## Promotion and Release

When an integration train is ready, open a promotion PR from the integration
branch to the matching stable branch, for example `v2-dev` to `v2`.

That promotion PR is the release-readiness gate and must pass required
cross-repo `E2E Tests`. The actual package release is cut from the stable branch
using a version tag after the stable branch is ready.

## `main`

`main` exists for GitHub UX and tools that require a stable default branch. It is
not a release branch and it is not the integration target.

This repo keeps `main` forwarded to the active integration branch using
automation. PRs opened against `main` are automatically retargeted to the branch
listed in `support/ci/ACTIVE_DEV_BRANCH`.

When changing the active integration branch, update
`support/ci/ACTIVE_DEV_BRANCH`, the repo docs, and the corresponding
`genlayer-e2e` release-train matrix in the same change set.
Loading