onaio / gisida

JavaScript library that converts MapSpec layers to beautiful, interactive maps using Mapbox GL
http://gisida.onalabs.org/
Apache License 2.0
11 stars 3 forks source link

Tracking Gisida Versions and Branches in Client Repos #431

Open cKellyDesign opened 4 years ago

cKellyDesign commented 4 years ago

Referencing: https://github.com/onaio/gisida/issues/428#issuecomment-586850390

We need to track which versions and branches our client repositories are using.

Gisida and Gisida React (public)

We should be able to run yarn install in the client repositories and install the correct versions / tags / branches. To do this let's maintain gisida and gisida-react as dependencies in the client package.json files.

// package.json
dependencies: {
  ...
  "gisida": "https://github.com/onaio/gisida#<branch/version/tag>",
  "gisida-react": "https://github.com/onaio/gisida-react#<branch/version/tag>",
   ...
}

Gisida React Private

Since this private repository is used as a submodule in client repositories, we can simply run:

git submodule init && git submodule update

to sync the submodule to the commit most recently checked into the client repository.

HOWEVER, this sets the local submodule git repo with a Detached HEAD, meaning further commits don't know where to push at origin, making it difficult to pick up and contribute.

Because of this I propose we start adding a comment in the clients' /src/index.js spelling out what branch is being used for the gisida-react-private repo.

Client Repositories

cKellyDesign commented 4 years ago

@akahure @engwiri @jholmes525 @msschroeder - Are there other active clients that I missed above?

Assigning to @akahure to:

akahure commented 4 years ago

@cKellyDesign thanks for these details, we still have a couple of more sites i.e.

A couple of things we need to look into as well

  1. We may also need to prioritise the clients we need to work on first.
  2. Do we also want specific Eng who worked on the sites to make updates or anyone in the team can do so ?
  3. What is the associated LOE with these changes/ per change
cKellyDesign commented 4 years ago

Thanks @akahure. I've added those three to the client list, I hadn't added any clients from the old Gisida Private but since they also use specific branches we should track them too.

  1. Yes please let's prioritized, this can be done by dragging the checkboxes above into a prioritized order
  2. Not necessarily, we could probably assign anyone and they will probably just have to do some digging and ask around when necessary to figure which branches are used where
  3. The bulk of the LOE will just be figuring which version/branch is being used and then a 1-2 line change in the actual client repo - I'm guessing between 5-15 min per task