...
- if a change is a bugfix on a previously merged patch, AND if that previous version is not already released
- then version change is optional
- different The repos need to have the version number expressed in multiple placesTBD: document those . . .
- In pom.xml, the project/version value is always specified as either W.X.Y or W.X.Y-SNAPSHOT, as in 1.3.2-SNAPSHOT.
- Every directory that has a pom.xml file should ALSO have a version.properties file AND a ChangeLog.md file.
- The same value (without any "-SNAPSHOT" suffix) will be specified in version.properties, separated out into separate major, minor and patch values:
- major=W
- minor=X
- patch=Y
- The same value will be specified in the ChangeLog.md file
Check the Build Console Output
...
- Ensure no outstanding patch remaining in gerrit for review/merge for container being released. We would want to avoid releasing container too frequently as well (consider consolidating release for multiple patch)
- As artifiact release impacts different repositories (blueprint/bootstrap, oom etc); consolidate release request (and subsequent update to other impacted repositories)
- For self-release yaml, ensure comment include description of changes/bug fixes introduced in that version. If multiple jira's are consolidated - include all Jira reference/brief summary
ChangeLog.md file
[This section is not yet agreed to.]
In the Istanbul release, we have adopted the practices of keeping a changelog. Best practices for changelogs can be found at <keepachangelog.com>.
An example of a changelog is:
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.0.0] - 2017-06-20
### Added
- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
- Version navigation.
- Links to latest released version in previous versions.
- "Why keep a changelog?" section. |
As committers, some of the things you should always check are:
- The name of the changelog may be specified in any case, but at least the letter "C" must be capitalized. We are using markdown, so the extension should always be "
.md". - Within the changelog:
- There should be an entry for every single version.
- The latest version should always be first, in reverse time order.
- The [Unreleased] section is optional.
- The date stamp must always be specified as either YYYY-MM-DD or YYYY/MM/DD.
Vacation Notice
- Notify other committers/PTL on vacation plans
- Set status accordingly in gerrit (under Gerrit->Setting→ Profile)
...