gapodo
/
forgejo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
forgejo/CONTRIBUTING.md

6.7 KiB
Raw Blame History

Forgejo Contributor Guide

This document explains how to contribute changes to the Forgejo project. Sensitive security-related issues should be reported to security@forgejo.org.

Development workflow

Forgejo is a soft fork, i.e. a set of commits applied to the Gitea development branch and the stable branches. On a regular basis those commits are rebased and modified if necessary to keep working. All Forgejo commits are merged into a branch from which binary releases and packages are created and distributed. The development workflow is a set of conventions Forgejo developers are expected to follow to work together.

Naming conventions

Development

  • Gitea: main
  • Forgejo: forgejo
  • Integration: forgejo-integration
  • Feature branches: forgejo-feature-name

Stable

  • Gitea: release/vX.Y
  • Forgejo: vX.Y/forgejo
  • Integration: vX.Y/forgejo-integration
  • Feature branches: vX.Y/forgejo-feature-name

Rebasing

Feature branch

The Gitea branches are mirrored with the Gitea development and stable branches.

On a regular basis, each Feature branch is rebased against the base Gitea branch.

Integration and Forgejo

The latest Gitea branch resets the Integration branch and all Feature branches are merged into it.

If tests pass, the Forgejo branch is reset to the tip of the Integration branch.

If tests do not pass, an issue is filed to the Feature branch that fails the test. Once the issue is resolved, another round of rebasing starts.

Releasing

When a tag is set to a Stable Forgejo branch, the CI pipeline creates and uploads binaries and packages.

Feature branches

All Feature branches are based on the *forgejo-development branch which provides and other development tools and documenation.

The *forgejo-development branch is based on the *forgejo-ci branch which provides the Woodpecker CI configuration.

The purpose of each Feature branch is documented below:

Contributing

Most people who are used to contributing will be familiar with the workflow of sending a pull request against the default branch. When that happens the reviewer should change the base branch to the appropriate Feature branch instead. If the pull request does not fit in any Feature branch, the reviewer needs to make decision to either:

  • Decline the pull request because it is best contributed to Gitea
  • Create a new Feature branch

Returning contributors can figure out which Feature branch to base their pull request on using the list of Feature branches found in CONTRIBUTING.md

Granularity

Feature branches can contain a number of commits grouped together, for instance for branding the documentation, the landing page and the footer. It makes it convenient for people working on that topic to get the big picture without browsing multiple branches. Creating a new Feature branch for each individual commit, while possible, is likely to be difficult to work with.

Observing the granularity of the existing Feature branches is the best way to figure out what works and what does not. It requires adjustments from time to time depending on the number of contributors and the complexity of the Forgejo codebase that sits on top of Gitea.

Release management

Shared user: release-team

The release-team user authors and signs all releases. The associated email is release@forgejo.org.

The public GPG key used to sign the releases is EB114F5E6C0DC2BCDD183550A4B61A2DC5923710 Forgejo Releases <release@forgejo.org>

Release numbering

The Forgejo release numbers are composed of the Gitea release number followed by a dash and a serial number. For instance:

  • Gitea v1.18.0 will be Forgejo v1.18.0-0, v1.18.0-1, etc

The Gitea release candidates are suffixed with -rcN which is handled as a special case for packaging: although X.Y.Z is lexicographically lower than X.Y.Z-rc1 is is considered greater. The Forgejo serial number must therefore be inserted before the -rcN suffix to preserve the expected version ordering.

  • Gitea v1.18.0-rc0 will be Forgejo v1.18.0-0-rc0, v1.18.0-1-rc0
  • Gitea v1.18.0-rc1 will be Forgejo v1.18.0-2-rc1, v1.18.0-3-rc1, v1.18.0-4-rc1
  • Gitea v1.18.0 will be Forgejo v1.18.0-5, v1.18.0-6, v1.18.0-7
  • etc.

Release process

  • Reset the vX.Y/forgejo-integration branch to the Gitea tag vX.Y.Z
  • Merge all feature branches into the vX.Y/forgejo-integration branch
  • If the CI passes reset the vX.Y/forgejo branch to the tip of vX.Y/forgejo-integration
  • Set the vX.Y.Z-N tag to the tip of the vX.Y/forgejo branch
  • Binaries are built, signed and uploaded by the CI.
  • Container images are built and uploaded by the CI.

Release signing keys management

A GPG master key with no expiration date is created and shared with members of the Owners team via encrypted email. A subkey with a one year expiration date is created and stored in the secrets repository, to be used by the CI pipeline. The public master key is stored in the secrets repository and published where relevant.

Master key creation

  • gpg --expert --full-generate-key
  • key type: ECC and ECC option with Curve 25519 as curve
  • no expiration
  • id: Forgejo Releases contact@forgejo.org
  • gpg --export-secret-keys --armor EB114F5E6C0DC2BCDD183550A4B61A2DC5923710 and send via encrypted email to Owners
  • gpg --export --armor EB114F5E6C0DC2BCDD183550A4B61A2DC5923710 > release-team-gpg.pub
  • commit to the secret repository

Subkey creation and renewal

  • gpg --expert --edit-key EB114F5E6C0DC2BCDD183550A4B61A2DC5923710
  • addkey
  • key type: ECC (signature only)
  • key validity: one year

2023

  • gpg --export --armor F7CBF02094E7665E17ED6C44E381BF3E50D53707 > 2023-release-team-gpg.pub
  • gpg --export-secret-keys --armor F7CBF02094E7665E17ED6C44E381BF3E50D53707 > 2023-release-team-gpg
  • commit to the secret repository

CI configuration

The releaseteamgpg secret in the Woodpecker CI configuration is set with the subkey.