https://lab.forgefriends.org/friendlyforgeformat/f3-documentation/badges/main/pipeline.svg

Friendly Forge Format (F3)

The Friendly Forge Format (abbreviated F3) is an Open File Format for storing the information from a forge such as issues, pull/merge requests, milestones, release assets, etc. as well as the associated VCS (Git, Mercurial, etc.).

The structure of the archive is a hierarchy of files that are:

  • JSON files with a normative JSON schema to describe what is usually stored in a forge database (issues, labels, etc.)

  • Content addressable files (avatars, release assets, attachments, software packages, etc.)

  • VCS directories (git, hg, etc.)

A reference implementation in Go is provided with drivers to mirror the forges to and from F3, with drivers for Forgejo, GitLab and Gitea.

Repositories

Resources