mirror of https://github.com/status-im/status-go.git synced 2026-08-31 00:51:12 +00:00

Files

T

Igor Sirotin 78800a17f3 docs: update and cleanup (#7112 )

* refactor: rename _docs to docs

* refactor: moved releasing.md to docs

* docs: delete policies

* refactor: rename building doc

* docs: update releasing

* docs: update building

* docs: update contributing

* docs: update readme

* docs: describe how to create release branch

2025-11-18 22:35:05 +00:00

2.0 KiB

Raw Permalink Blame History

Release Process of status-go

Releases are only done manually, and are synced to Status App releases.

Versioning

For details on status-go's versioning approach, including how we handle Go modules, generated files, and our release workflow, see docs/versioning.md.

Release branch

The release branch takes the form of release/vA.B.x, where x is hardcoded. For example a valid release branch name is release/v0.177.x or release/v10.7.x. Commits on this branch may be tagged as releases.

Creating a new release branch

Only admins can create release branches. To prevent direct pushes to existing release/* branches, we use a GitHub ruleset that blocks pushes for everyone, including admins.

To create a new release branch, an admin must:

Go to GitHub repository Settings → Rules → Rulesets → "Release Update Rules"
For Repository admin in Bypass list: temporarily change Bypass actor actions from For pull requests only to Always
Create and push the new release branch
Immediately switch the setting back to "For pull requests only"

Once created, all changes to release branches must go through pull requests.

Tagging versions

To tag a version, you should run the command:

make tag-version to create a tag for HEAD

make tag-version TARGET_COMMIT={hash} to create a tag for a specific hash

You will have to then check the tag is correct, and push the tag:

git push origin {tag_created}

That can then be used as a stable tag.

Releasing a version with generated files

Since https://github.com/status-im/status-go/pull/5878, we don't commit the generated files. This made status-go not "go-gettable" anymore. This is almost never a problem, because the main client of status-go is the Status App, which gets status-go as a Git submodule.

Nevertheless, there are cases when status-go is used as a dependency of another Go project, e.g. https://github.com/status-im/matterbridge. A workaround for such cases is described in https://github.com/status-im/status-go/pull/6594.

2.0 KiB Raw Permalink Blame History