2024-01-29 12:30:13 -06:00
# Releases
2024-02-09 07:48:10 -06:00
!!! info "Changelog"
This document describes how we release uMap.
If you are looking for the releases changelog, [please go there ](changelog.md ).
2024-01-29 12:30:13 -06:00
## How to make a release
2023-08-25 08:46:26 -05:00
2024-01-08 05:51:11 -06:00
1. Run tests:
- `make test`
2023-08-25 08:46:26 -05:00
1. I18N
- `make messages` look for new strings within the code
- `make tx_push` to publish new strings [to transifex ](https://app.transifex.com/openstreetmap/umap/dashboard/ )
- translators at work
- `make tx_pull` to retrieve new translations from transifex
- `make compilemessages` to create regular `.mo` + `umap/static/umap/locale/*.js`
2023-09-23 14:58:37 -05:00
- commit new translations `git commit -am "i18n"`
2024-02-09 11:41:04 -06:00
2. Test collectstatic: `umap collectstatic --no-input`
2023-08-25 08:46:26 -05:00
2. Bump version: `make patch|minor`
2024-05-09 11:08:08 -05:00
3. `git commit -am "2.X.Y"`
4. `git tag 2.X.Y`
2023-08-25 08:46:26 -05:00
5. `git push && git push --tag`
6. Go to [Github release page ](https://github.com/umap-project/umap/releases/new ) and Generate release notes + paste it in `docs/changelog.md` + finish Github process for a new release
2023-09-23 14:58:37 -05:00
7. Commit the changelog `git commit -am "changelog"`
2023-09-22 13:58:33 -05:00
8. `make build`
9. `make publish`
10. `make docker`
2023-08-25 08:46:26 -05:00
2024-01-29 12:30:13 -06:00
### Deploying instances
2023-08-25 08:46:26 -05:00
2024-01-29 12:30:13 -06:00
#### OSMfr
2023-08-25 08:46:26 -05:00
2024-02-09 07:48:10 -06:00
We use a custom flat Makefile, versioned [here ](https://github.com/umap-project/umap-deploy ).
To deploy a new version on the [dev ](https://dev.umap-project.org ) server:
- edit the `.env.dev` file and change the version number
- run this command `FLAVOUR=dev make deploy`
To deploy a new version on OSM France servers:
- edit the `.env.osmfr` file and change the version number
- run this command `FLAVOUR=osmfr make deploy`
2023-08-25 08:46:26 -05:00
2024-01-29 12:30:13 -06:00
#### ANCT
2023-08-25 08:46:26 -05:00
2023-08-25 08:58:41 -05:00
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.
2024-01-29 12:30:13 -06:00
## 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
