This repository has been archived by the owner on Sep 2, 2024. It is now read-only.
Draft release guidelines doc #123
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Camara versioning guidelines | ||
|
|
||
| * Every release includes a **CHANGELOG.md** file. Please make sure that the content is structured in a format that is easy to read. | ||
| * Release should follow the convention **\<subprj-name> \<tag-name>** | ||
|
There was a problem hiding this comment. What is |
||
| * Changelog content: | ||
| * APIs/Software in alpha release needs to be clearly specified | ||
| * API changes | ||
|
There was a problem hiding this comment. We could propose a template, and give some guidelines about the expected level of detail, for example: ChangelogX.Y.Z [ALPHA] - YYYY-MM-DDAdded
Changed
Fixed
Removed
There was a problem hiding this comment. @jlurien Much appreciated! I can add this as a separate md file and refer it in this doc There was a problem hiding this comment. doc and link are now added |
||
| * New features | ||
| * Fixes | ||
| * Deprecation (if any) | ||
| * Release branches should have naming convention **release-x.y.z** | ||
| * Tags should follow the naming conventions <strong>vx.y.z</strong> for versions | ||
| * Adding relevant annotations to tags will be useful for later reference. | ||
| * Bugfix branches can follow, naming as **patch-x.y.z** | ||
| * 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. | ||
|
|
||
| <img src="../images/versioning-pic.png" alt="Ver" | ||
| title="Versioning Sample"/> | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be good to agree on a common location for this file, for example code/API_definitions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jlurien CHANGELOG.md is normally at the root of the repo alongside README.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, maybe instead of having a CHANGELOG.md for each realease is more convenient actually, to have a common file in
mainbranch included all cumulative changes of each release/version i.e. actually each new release con just change that file adding the corresponding changes. Specific changes for each release could be included in the release notes, you could even include a link to the detailed change log using thecomparegithub feature (you can compare your release against any previous tag/release).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jpengar CHANGELOG.md will be made available in every release branch. It's location is right beside the README file. In the main branch the changelog file could either be kept empty or can be used to give an overview as you have stated above of the releases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And we may think about using the github concept of pre-release if the release is not production ready.