Skip to content

Latest commit

 

History

History
121 lines (104 loc) · 5.32 KB

RELEASES.md

File metadata and controls

121 lines (104 loc) · 5.32 KB

Releases

This document describes the versioning and release process of OpenFGA. This document will be considered a living document. Scheduled releases, supported timelines, and API stability guarantees will be updated here as they change.

Release Cycle

OpenFGA endeavors to follow a [4 | 6] release cycle with new releases in the openfga/openfga and openfga/helm-chats repositories, including OpenFGA server binaries, container images published on DockerHub, and updated Helm charts for each new version. Off-cycle releases may also occur when required to address critical issues.

Versioning

Releases of OpenFGA will be versioned using dotted triples. For the purposes of this document, we will refer to the respective components of this triple as <major>.<minor>.<patch>. When release candidates are published, they will include the suffix "-RC" followed by a release candidate number identifying them as "pre-releases."

Major and Minor Releases

Changes in the major and minor version components of the triple indicate changes in the functionality or performance of OpenFGA which may include breaking changes requiring those integrating OpenFGA in their project to make changes in their use of OpenFGA when adopting the new version. It is recommended that the published release notes accompanying a new release be fully reviewed before upgrading.

Patch Releases

Releases that increment only the "patch" component of the version triple may introduce new functionality, performance enhancements, bug fixes, or preview features while remaining backward compatible with the previous release.

Release History

Release dates for all releases (not including release candidates).

Version Release Date
v1.5.9 Aug 13, 2024
v1.5.8 Aug 8, 2024
v1.5.7 Jul 26, 2024
v1.5.6 Jul 17, 2024
v1.5.5 Jun 18, 2024
v1.5.4 May 30, 2024
v1.5.3 Apr 16, 2024
v1.5.2 Apr 3, 2024
v1.5.1 Mar 20, 2024
v1.5.0 Mar 4, 2024
v1.4.3 Jan 26, 2024
v1.4.2 Jan 10, 2024
v1.4.1 Jan 4, 2024
v1.4.0 Dec 11, 2023
v1.3.10 Dec 8, 2023
v1.3.9 Dec 5, 2023
v1.3.8 Dec 4, 2023
v1.3.7 Nov 7, 2023
v1.3.6 Nov 6, 2023
v1.3.5 Oct 26, 2023
v1.3.4 Oct 17, 2023
v1.3.3 Oct 5, 2023
v1.3.2 Sep 26, 2023
v1.3.1 Aug 25, 2023
v1.3.0 Aug 1, 2023
v1.2.0 Jun 30, 2023
v1.1.1 Jun 26, 2023
v1.1.0 May 17, 2023
v1.0.1 Apr 18, 2023
v1.0.0 Apr 14, 2023
v0.4.3 Apr 12, 2023
v0.4.2 Mar 17, 2023
v0.4.1 Mar 16, 2023
v0.3.7 Feb 22, 2023
v0.3.6 Feb 16, 2023
v0.3.5 Feb 16, 2023
v0.3.4 Feb 3, 2023
v0.3.3 Jan 31, 2023
v0.3.2 Jan 18, 2023
v0.3.1 Dec 19, 2022
v0.3.0 Dec 13, 2022
v0.2.5 Nov 7, 2022
v0.2.4 Oct 24, 2022
v0.2.3 Oct 6, 2022
v0.2.2 Sep 15, 2022
v0.2.1 Aug 30, 2022
v0.2.0 Aug 15, 2022
v0.1.7 Jul 29, 2022
v0.1.6 Jul 27, 2022
v0.1.5 Jul 27, 2022
v0.1.4 Jun 27, 2022
v0.1.3 Mar 2, 2023
v0.1.2 Jun 20, 2022
v0.1.1 Jun 17, 2022
v0.1.0 Jun 10, 2022

Roles

Release Manager

One of the OpenFGA maintainers is designated as the release manager. The release manager is tasked with:

  • Communicating the release status with other maintainers.
  • Review the included PRs and compile a descriptive changelog detailing the changes included in the new release using language that is meaningful and easy to understand for humans and ensures that contributors to the release are acknowledged.
  • Discuss the level of testing that is needed and create a test plan, if sensible, including any areas where test coverage should be expanded.
  • Creating pull requests in the appropriate repositories and creating a new GitHub tag (ie. <vX.Y.Z>) indicating the version triple for the new release.
  • Verify the release's publication to GitHub and DockerHub and the release of the associated Helm chart.
  • Publishing release announcements or coordinating with other maintainers and community managers to publish release announcements to the openfga.dev website, the #openfga channel in the CNCF slack, and on other channels.

In addition to these duties, if the release is a security fix, the release manager will coordinate with relevant maintainers and contributors to create and publish a CVE detailing the identified vulnerabilities and their resolution.

Artifacts

Binaries

MacOS

  • openfga_X.Y.Z_darwin_amd64.tar.gz
  • openfga_X.Y.Z_darwin_amd64.tar.gz.sbom.json
  • openfga_X.Y.Z_darwin_arm64.tar.gz
  • openfga_X.Y.Z_darwin_arm64.tar.gz.sbom.json

Linux

  • openfga_X.Y.Z_linux_386.tar.gz
  • openfga_X.Y.Z_linux_386.tar.gz.sbom.json
  • openfga_X.Y.Z_linux_amd64.tar.gz
  • openfga_X.Y.Z_linux_amd64.tar.gz.sbom.json
  • openfga_X.Y.Z_linux_arm64.tar.gz
  • openfga_X.Y.Z_linux_arm64.tar.gz.sbom.json

Windows

  • openfga_X.Y.Z_windows_386.tar.gz
  • openfga_X.Y.Z_windows_386.tar.gz.sbom.json
  • openfga_X.Y.Z_windows_amd64.tar.gz
  • openfga_X.Y.Z_windows_amd64.tar.gz.sbom.json
  • openfga_X.Y.Z_windows_arm64.tar.gz
  • openfga_X.Y.Z_windows_arm64.tar.gz.sbom.json

Container Images

An updated container image is published to https://hub.docker.com/r/openfga/openfga for each new OpenFGA release.

Helm Charts

Updated Helm Charts are published to https://openfga.github.io/helm-charts for each new OpenFGA release.