Skip to content
This repository has been archived by the owner on Sep 2, 2024. It is now read-only.

Draft release guidelines doc #123

Merged
merged 20 commits into from
Mar 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Changelog

## X.Y.Z [ALPHA] - YYYY-MM-DD

### Added

* New property `new_name`
* New endpoint `new_name`
* Examples

### Changed

* Property `old_name` renamed to `new_name`
* Format for property `property` changed to `new_format`

### Fixed

* Typos fixed
* Reference corrected

### Removed

* Deprecated field `old_field`
* Deprecated endpoint
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Camara subproject release guidelines

* Release name for subprojects should be same as the tag-name for e.g. v0.8.0. The Github [release feature](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) should be used for this purpose. If referenced outside the subproject, it can be referred to as Release **\<sub-project-name>\<tag-name>** for eg. Release QualityOnDemand v0.8.0
* Every release includes the **CHANGELOG.md** file in the root directory of the subproject. Please make sure that the content is structured in a format that is easy to read. Please refer to the template provided here for possible sections that could be added to a changelog [CHANGELOG_TEMPLATE.md](./CHANGELOG_TEMPLATE.md). Every release would add to the changelog. An example of how a changelog could look over time is shown below.
* The release can be agreed within the subproject by making a pull request for the changelog. The merge of this pull request would be marked as the release commit and the text within the changelog would be used as the release description
* Changelog content:
* APIs/Software in alpha release needs to be clearly specified
* API changes (This should include/cover all API objects which are part of the API bundle)
* New features
* Fixes
* Deprecation (if any)
* Going ahead, we could decide on a pull request process where use of right PR annotations could allow us to use tooling such as [krel](https://github.com/kubernetes/release/blob/master/docs/krel/README.md) or similar to automate atleast parts of release management.
* Release branches should have naming convention **release-x.y.z**
* Release tags should follow the naming conventions <strong>vx.y.z</strong> for versions
* Adding relevant annotations to tags will be useful for later reference.
* Provider implementation repos can have their own naming conventions with regard to branches, tags etc. It is however mandatory to provide as a part of the  CHANGELOG.md - the API release version, capabilities and changes that are a part of the respective provider implementation release.
* Main branch is assumed to be the latest.
* Camara subproject will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release of any given subproject within Camara.
* The commonalities WG does not impose any restrictions on the subprojects for creating other branches, tags which might be needed/useful to address their specific requirements. The above said guidelines are only applicable for the subproject releases.

### Release branches
<img src="../images/versioning-pic.png" alt="Ver"
title="Versioning Sample"/>

### Changelog
<img src="../images/CL.png" alt="Changelog"
title="Changelog Sample"/>
Binary file added Commonalities/documentation/images/CL.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.