Note: This plan was developed based on input received in the Sept 10, 2021 Release Process Meeting
The purpose of this document is to describe how and when release artifacts produced from the Anuket Release Process will be hosted and published.
Documentation must follow the existing Read-The-Docs organization, formatting, and process flow (see DOCs project). Containers must use the Docker format. There are no requirements or restrictions on other types of release artifacts.
Regardless of artifact type or format, all projects should observe the following principles.
All release artifacts will be "accessible" to community members and end users. This means that release artifacts will be in a widely used, open format that is available to most users, regardless of company affiliation or region.
The documentation, updated for every release, will clearly explain the installation requirements, the installation process, and the use and operation of all release artifacts. The documentation will provide release-specific pointers to all release artifacts.
In addition, docker containers will be published to GitLab (following transition). This will enable projects to take advantage of security scanning in GitLab, and also avoid access limits in Docker Hub.
However, publishing to GitLab will only be used to facilitate Anuket build processes. Docker Hub will be the "official" registry for end users, and will be the location published by projects in their documentation.
Note that older images that are referenced in prior RC releases will continue to be maintained in OPNFV in order to avoid breaking those releases.
Other Software Artifacts
Other software artifacts will be published to S3. There are existing releng jobs that may be used to facilitate this.
Software release artifacts will be prepared for release between M5 and M6 (1 week) of the Anuket release process, as follows:
- Update releng job to use release branch instead of master
- Tag the version of artifacts to be released on the release branch
- Release manager collects artifact references from PTLs and communicates those to releng
- For traditional installation packages (rpm, tarball, etc.) releng moves artifacts to hosting location and provides URLs to Release Manager.
- Release manager verifies URLs
- Release manager provides confirmed URL list to projects for documentation
- Release manager provides URL to project documentation for participating projects to website manager for publication
- Website is updated with release-specific section or page containing links to release documentation for participating projects by Go Live date (typically within a week following technical release date (M6))
The website will include a release section, or page, with subsections, or pages, for each release. Within the release-specific page or section will be listed links to the documentation for each participating project. It will be the responsibility of each project to provide updated descriptions of the installation process, including release-specific links to release artifacts. It's important to note that the website will NOT include links to software release artifacts, but only links to documentation.
- No labels