Style changes merge bottleneck #6167

Open
opened 2023-10-01 07:23:31 +00:00 by pastk · 0 comments
Member

Its great that we have more people contributing to styles lately! Many thanks to everyone involved! @RedAuburn @dvdmrtnz @map-per

However it made apparent that we have a shortcoming with our workflow:
there is a queue of style PRs waiting to be merged, but we can't merge them at once because after one is merged all other need to be rebased, which takes time and focus unnecessarily.

Merge conflicts are due to binary drules_*.bin files (and symbols.png skin files when icons are changes, but its not that big issue for now) which just can't be merged.

Also complete rewrite of binary files for every minor change makes our repository size grow bigger faster and faster (e.g. a single icon update leads to >6Mb of additional skin files versions).
Also each rebase and push makes the CI builds and tests run anew (takes time and there is a rate limit for free github CI, right?).

An ultimate solution would be to stop storing binary drules and skin files in the repo, but generate them on-the-fly from the sources e.g. just before building an app.

However there are many dependencies on those binaries ATM which make it a big task:

  • style binaries should be generated automatically/transparently for each platform build, so that a build env setup process is not more complicated
  • automatic tests run by github CI (which include styles-related tests) depend on style binaries too, so they have to be generated automatically there too (and it shouldn't slow down this process much)
  • similarly, the maps generator depends on style binaries too

So it would be great to find an interim simpler solution, let's brainstorm!

CC @biodranik @vng

Its great that we have more people contributing to styles lately! Many thanks to everyone involved! @RedAuburn @dvdmrtnz @map-per However it made apparent that we have a shortcoming with our workflow: there is a queue of style PRs waiting to be merged, but we can't merge them at once because after one is merged all other need to be rebased, which takes time and focus unnecessarily. Merge conflicts are due to binary `drules_*.bin` files (and `symbols.png` skin files when icons are changes, but its not that big issue *for now*) which just can't be merged. Also complete rewrite of binary files for every minor change makes our repository size grow bigger faster and faster (e.g. a single icon update leads to >6Mb of additional skin files versions). Also each rebase and push makes the CI builds and tests run anew (takes time and there is a rate limit for free github CI, right?). An ultimate solution would be to stop storing binary drules and skin files in the repo, but generate them on-the-fly from the sources e.g. just before building an app. However there are many dependencies on those binaries ATM which make it a big task: - style binaries should be generated automatically/transparently for each platform build, so that a build env setup process is not more complicated - automatic tests run by github CI (which include styles-related tests) depend on style binaries too, so they have to be generated automatically there too (and it shouldn't slow down this process much) - similarly, the maps generator depends on style binaries too So it would be great to find an interim simpler solution, let's brainstorm! CC @biodranik @vng
This repo is archived. You cannot comment on issues.
No labels
Accessibility
Accessibility
Address
Address
Android
Android
Android Auto
Android Auto
Android Automotive (AAOS)
Android Automotive (AAOS)
API
API
AppGallery
AppGallery
AppStore
AppStore
Battery and Performance
Battery and Performance
Blocker
Blocker
Bookmarks and Tracks
Bookmarks and Tracks
Borders
Borders
Bug
Bug
Build
Build
CarPlay
CarPlay
Classificator
Classificator
Community
Community
Core
Core
CrashReports
CrashReports
Cycling
Cycling
Desktop
Desktop
DevEx
DevEx
DevOps
DevOps
dev_sandbox
dev_sandbox
Directions
Directions
Documentation
Documentation
Downloader
Downloader
Drape
Drape
Driving
Driving
Duplicate
Duplicate
Editor
Editor
Elevation
Elevation
Enhancement
Enhancement
Epic
Epic
External Map Datasets
External Map Datasets
F-Droid
F-Droid
Fonts
Fonts
Frequently User Reported
Frequently User Reported
Fund
Fund
Generator
Generator
Good first issue
Good first issue
Google Play
Google Play
GPS
GPS
GSoC
GSoC
iCloud
iCloud
Icons
Icons
iOS
iOS
Legal
Legal
Linux Desktop
Linux Desktop
Linux packaging
Linux packaging
Linux Phone
Linux Phone
Mac OS
Mac OS
Map Data
Map Data
Metro
Metro
Navigation
Navigation
Need Feedback
Need Feedback
Night Mode
Night Mode
NLnet 2024-06-281
NLnet 2024-06-281
No Feature Parity
No Feature Parity
Opening Hours
Opening Hours
Outdoors
Outdoors
POI Info
POI Info
Privacy
Privacy
Public Transport
Public Transport
Raw Idea
Raw Idea
Refactoring
Refactoring
Regional
Regional
Regression
Regression
Releases
Releases
RoboTest
RoboTest
Route Planning
Route Planning
Routing
Routing
Ruler
Ruler
Search
Search
Security
Security
Styles
Styles
Tests
Tests
Track Recording
Track Recording
Translations
Translations
TTS
TTS
UI
UI
UX
UX
Walk Navigation
Walk Navigation
Watches
Watches
Web
Web
Wikipedia
Wikipedia
Windows
Windows
Won't fix
Won't fix
World Map
World Map
No milestone
No project
No assignees
1 participant
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: organicmaps/organicmaps-tmp#6167
No description provided.