Skip to content

Commit

Permalink
Add readme_release back (updated)
Browse files Browse the repository at this point in the history
Also minor typo change
  • Loading branch information
Pierre-Etienne Bougue committed Feb 28, 2023
1 parent de825e3 commit f7a75ce
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
26 changes: 26 additions & 0 deletions readme_release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# HOW TO Release navitia

## Versioning

Our versionning is based on [Semantic Versionning](https://semver.org/)
* The **major** version is bumped in case of an API/interface change or **when a binarisation is needed**.
If the `data_version` located in `source/type/data.cpp` changes, then binarisation is needed (See
[CONTRIBUTING.md](CONTRIBUTING.md) for details on how `data_version` is managed).
* the **minor** version is bumped when functionnalities are backward compatible.
* the **patch** version is bumped on a bug fix.

## Releasing

First have a look on github's repo at PRs about to be released, using
[recently merged PRs](https://github.com/hove-io/navitia/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc)
and commits merged since `<latest_version>` (replace with [latest tag](https://github.com/hove-io/navitia/releases)):
[https://github.com/hove-io/navitia/compare/`<latest_version>`...dev](https://github.com/hove-io/navitia/compare/<latest_version>...dev)
* Adjust/check that `not_in_changelog` and `hotfix` labels are correct and none is missing on PRs that are gonna be released
* Adjust/check that titles are correct (typo, clarity, with the component impacted)

Then publish the release on Github:
* In [Github's release page](https://github.com/hove-io/navitia/releases), click `Draft a new release`
* Tag to create and version names are going to be the same: `vX.Y.Z`
* Click `Generate release notes` and review the page, then publish.
* :heavy_check_mark: Let the CI do its work, and draft some PRs to deploy
components of this new version everywhere necessary.
2 changes: 1 addition & 1 deletion source/kraken/metrics.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Metrics::Metrics(const boost::optional<std::string>& endpoint, const std::string
}
auto& in_flight_family = prometheus::BuildGauge()
.Name("kraken_request_in_flight")
.Help("Number of requests currently beeing processed")
.Help("Number of requests currently being processed")
.Labels({{"coverage", coverage}})
.Register(*registry);
this->in_flight = &in_flight_family.Add({});
Expand Down

0 comments on commit f7a75ce

Please sign in to comment.