From c3691b235e6413880c615cc1785eedc8a4fd569b Mon Sep 17 00:00:00 2001 From: David Larlet Date: Mon, 29 Jan 2024 13:30:13 -0500 Subject: [PATCH] docs: define an explicit release stragegy --- docs/changelog.md | 2 +- docs/release.md | 33 +++++++++++++++++++++++++++++---- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 7c28d262..dd7a6e3c 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -42,7 +42,7 @@ - `umap/templates/umap/map_table.html` - `umap/templates/umap/user_dashboard.html` -[See the diff](https://github.com/umap-project/umap/compare/1.12.2...1.13.0#diff-1311890945256dbddf0e59928c2e9d4f59fd6bcc6b1fd33719ef35f03e5168b4). +[See the diff](https://github.com/umap-project/umap/compare/1.12.2...1.13.0#files_bucket). ## 1.12.2 - 2023-12-29 diff --git a/docs/release.md b/docs/release.md index fbb3e696..947f77ee 100644 --- a/docs/release.md +++ b/docs/release.md @@ -1,4 +1,6 @@ -# How to make a release +# Releases + +## How to make a release 1. Run tests: - `make test` @@ -20,12 +22,35 @@ 9. `make publish` 10. `make docker` -## Deploying instances +### Deploying instances -### OSMfr +#### OSMfr The process is manual for now, Yohan has one Makefile on his computer. -### ANCT +#### ANCT Update the [Dockerfile](https://gitlab.com/incubateur-territoires/startups/donnees-et-territoires/umap-dsfr-moncomptepro/-/blob/main/Dockerfile?ref_type=heads) with correct version and put a tag `YYYY.MM.DD` in order to deploy it to production. + + +## When to make a release + +We aim to support [Baseline](https://developer.mozilla.org/en-US/blog/baseline-evolution-on-mdn/) “Widely available” (implemented in major browsers within the last 30 months). + +### Major (2.Y.Z) + +* when we bump Django to a major version +* when we change how we store data (both in database and filesystem) + +### Minor (X.3.Z) + +* when we add new features +* when we improve an existing feature +* when we improve the usability +* when we change templates + +If it's not a major nor a patch, it's a minor. + +### Patch (X.Y.12) + +* when there are bugfixes