WIP

Introduction

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 >>

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

• 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
    • Needs information (e.g. scope definitions) about the planned and done releases from the sub projects
    • This information has to be provided in a way that can be automated collected
  • API sub project(s) <= Commonalities
    • all API Sub Projects need to know the release of the Commonalities documents and artefacts which they have follow for their release
  • Commonalities <= Identity & Consent management
    • Commonalities (a release of Commonalities is referring to documents within a release of I&CM)
• Potential milestones:
  • Kick-off
    • and Scope of I&CM and Commonalities
    • 4 weeks
  • Release candidates of Commonalities
    • Scope defined per sub projects (could be part of one the previous lines)
    • 4 weeks
  • Release of Commonalities
    • 4-6
  • (First) Release Candidates of sub projects
    • 4-6 weeks
  • Sub project releases
    • 2 weeks
  • Common Release Date ("packaging done for the community release")
  • Release Retro
• Release cadence:
  • 2 releases per year as a target
• Initial schedule:

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