Skip to content

Commit f7a75ce

Browse files
author
Pierre-Etienne Bougue
committed
Add readme_release back (updated)
Also minor typo change
1 parent de825e3 commit f7a75ce

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

readme_release.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# HOW TO Release navitia
2+
3+
## Versioning
4+
5+
Our versionning is based on [Semantic Versionning](https://semver.org/)
6+
* The **major** version is bumped in case of an API/interface change or **when a binarisation is needed**.
7+
If the `data_version` located in `source/type/data.cpp` changes, then binarisation is needed (See
8+
[CONTRIBUTING.md](CONTRIBUTING.md) for details on how `data_version` is managed).
9+
* the **minor** version is bumped when functionnalities are backward compatible.
10+
* the **patch** version is bumped on a bug fix.
11+
12+
## Releasing
13+
14+
First have a look on github's repo at PRs about to be released, using
15+
[recently merged PRs](https://github.com/hove-io/navitia/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc)
16+
and commits merged since `<latest_version>` (replace with [latest tag](https://github.com/hove-io/navitia/releases)):
17+
[https://github.com/hove-io/navitia/compare/`<latest_version>`...dev](https://github.com/hove-io/navitia/compare/<latest_version>...dev)
18+
* Adjust/check that `not_in_changelog` and `hotfix` labels are correct and none is missing on PRs that are gonna be released
19+
* Adjust/check that titles are correct (typo, clarity, with the component impacted)
20+
21+
Then publish the release on Github:
22+
* In [Github's release page](https://github.com/hove-io/navitia/releases), click `Draft a new release`
23+
* Tag to create and version names are going to be the same: `vX.Y.Z`
24+
* Click `Generate release notes` and review the page, then publish.
25+
* :heavy_check_mark: Let the CI do its work, and draft some PRs to deploy
26+
components of this new version everywhere necessary.

source/kraken/metrics.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Metrics::Metrics(const boost::optional<std::string>& endpoint, const std::string
103103
}
104104
auto& in_flight_family = prometheus::BuildGauge()
105105
.Name("kraken_request_in_flight")
106-
.Help("Number of requests currently beeing processed")
106+
.Help("Number of requests currently being processed")
107107
.Labels({{"coverage", coverage}})
108108
.Register(*registry);
109109
this->in_flight = &in_flight_family.Add({});

0 commit comments

Comments
 (0)