Introduction

A CAMARA meta-release is the way CAMARA brings its APIs to market.

A meta-release consists of a set of public versions of curated APIs that went though the CAMARA meta-release process.

WIP

...

The purpose of this document is to describe the cadence, processes, milestones, and associated tasks used in the CAMARA release cycle. See CAMARA Releases for information and schedule for specific releases.

Overview

CAMARA releases is scheduled to twice per year at approximately 6 month intervals (May and November). Releases are named after major world cities in alphabetical order. See the CAMARA Release Roadmap for a list of previous and future releases.

Releases are administered and tracked by a Community Release Managers. Release status is discussed at the << TBC >>

Release Milestones

Release milestones and their associated tasks, are used to track the status of the release. The milestones and management tasks used in the release process are described in the table below.

...

define

• the milestones of the meta-release (this page), and the supporting Meta-release Process documentation
• the activities expected from the different teams to move from one milestone to the next
• the way to report progress on the meta-release itself, on the Commonalities and ICM releases and on API releases

For the schedule and content of actual planned meta-releases, see CAMARA meta-releases.

Meta-release milestones

Meta-release milestones and their associated actions are used to progress and track the status of the meta-release. 

• A meta-release has 6 milestones, M0 through M6 described below. 
• For the typical milestone dates of a meta-release, please see the Meta-release Process.

The following table lists the meta-release milestones, and includes a high level view of the activities expected from the various teams to reach these milestones. 

More details on these for each team are documented here: 

• • Commonalities, ICM: release tracking and milestone activities
  • API Sub Projects: release tracking and milestone activities
  • Release Management: meta-release tracking and milestone activities
  • TSC: milestone activities

Processes

All CAMARA teams play their part in the meta-release process. An overview of the activities per team is shown in the above table.

The details on the activities for each team can be found in the below process descriptions:

• The process to manage a meta-release is described here: Meta-release Process
• The process for the Commonalities and ICM teams is described here: Commonalities and ICM release process
• Details on releasing an API version and the related API versioning are described here: API Release Process. 

...

Bundle & publish release

- Common Release Date ("packaging done for the community release")

....................................

• Work products needed:
  • Commonalities
    • API-design-guidelines.md
    • Camara_Versioning_Guidelines.md
    • Glossary.md
    • Linting rules (representing the guidelines)
  • Identity & Consent Management
    • CAMARA-API-access-and-user-consent.md
    • CAMARA-AuthN-AuthZ-Concept.md
    • Note: documents will be incorporated into Commonalities release at some point of time, until then they be referenced by Commonalities
  • Release Management
    • Overview of released APIs and their version and status
    • Release management process
  • For each (API) sub projects: 
    • API Definition(s)
      • Following the Commonalities guidelines
      • Successful linting check (with latest rules provided by Commonalities
      • Inline documentation, usable together with swagger editor and redoc
    • Test definitions
      • .feature files according to guideline from Commonality (comes with v0.2.0)
    • Supplementary documentation if needed to use or implement the API definition(s)
      • User documentation should be including the API Definition

Dependencies

• Release Management <= Commonalities, API Sub Projects:

Scope Definitions: Each release cycle involves defining the scope of work for commonalities, and sub-projects/APIs.
Planned Releases: Release management maintains a centralized repository of planned releases for commonalities and sub-projects/APIs, including their respective scope definitions and timelines.

Releases from Sub-Projects/APIs: Information about releases from sub-projects/APIs is collected and documented. This includes details such as release version, release date, features implemented, bug fixes, and any other relevant information.

• API Sub-Projects <= Commonalities:

Release Dependency: All sub-projects/APIs depend on the release of commonalities documents and artifacts for their own releases.

Follow Commonalities Release: sub-projects/APIs need to synchronize their release cycles with the release of commonalities. 

Integration Testing: Before each sub-project/API candidate release, integration testing is conducted to verify compatibility with the latest commonalities release. Any discrepancies or issues are addressed before proceeding with the sub-project release.

Documentation and Artefacts: Sub-projects/APIs reference specific versions of commonalities documents and artefacts as part of their release process. This information is documented and tracked to maintain traceability and ensure compliance.

• Commonalities <= Identity & Consent Management:

Release Alignment: Commonalities releases are closely aligned with the release cycles of Identity & Consent Management (I&CM). A release of commonalities refers to documents and artifacts within a release of I&CM.

Versioning and Tagging: Commonalities documents and artifacts are versioned and tagged according to Camara_Versioning_Guidelines.md. This allows for easy identification and retrieval of specific versions when needed.

Dependency Management: I&CM provides the foundational framework for commonalities, which in turn serves as the basis for sub-projects/APIs. Any changes or updates in I&CM are reflected in commonalities, ensuring consistency and coherence across the CAMARA project.

Guidelines towards Sub Projects regarding releases and versioning

• ACTION: a task force to address the collected issues around release and versioning in sub project should be run in context of the Release Management working group
• Collected issues: https://github.com/camaraproject/ReleaseManagement/issues/9
• Commonalities documents which are relevant:Camara_Versioning_Guidelines.md