mepo workflow (change in GOCART, part of GEOSgcm fixture)

[pchakraborty]

Let’s consider a change in the GOCART repository, as part of the GEOSgcm fixture. The repository hierarchy looks like

GEOSgcm → GEOSgcm_GridComp → GEOSchem_GridComp → GOCART

with a central registry file (components.yaml) in the fixture repository GEOSgcm. The workflow for a change in the GOCART repository would look like

Checkout some version of GEOSgcm

mepo clone -b <version> git@github.com:GEOS-ESM/GEOSgcm.git

GOCART steps

Local

(Local) Step 1: Create branch in GOCART and the fixture

mepo checkout -b feature/<user>/gocart/some-change GOCART GEOSgcm

(Local) Step 2: Modify GOCART files and commit

Commit all changes to feature/<user>/gocart/some-change in GOCART

mepo commit -m "message" GOCART

(Local) Step 3: Save the current state

mepo save

This does the following

• Ensure all changes have been committed
• Write new state and update registry

Note

The current version of mepo save, by default, writes a new registry components-new.yaml instead of modifying the original one. It should probably update components.yaml instead.

(Local) Step 4: Push all changes

Push feature/<user>/gocart/some-change from GOCART and GEOSgcm to GitHub

mepo push GOCART GEOSgcm

Remote - GitHub

(GitHub) Step 1: Pull request

Create PR for GOCART to merge feature/pchakrab/<user>/some-change into develop.

(GitHub) Step 2: Merge and issue v-tag

1. Merge feature/<user>/gocart/some-change into develop.
2. Wait for develop to be merged in to main.
3. Create a new GOCART v-tag (release) that includes the new changes (e.g. v78.14.1)

GEOSgcm steps

Local

(Local) Step 1

Check out v78.14.1 in GOCART

mepo fetch
mepo checkout v78.4.1 GOCART

Caution

In case of a fresh clone, when GEOSgcm doesn't have feature/<user>/gocart/some-branch checked out, we need an extra step
mepo checkout feature/<user>/gocart/some-branch GEOSgcm

(Local) Step 2

mepo save

This ensures that GEOSgcm is now pointing to GOCART's v-tag just released

(Local) Step 3

mepo push GEOSgcm

Remote - GitHub

(GitHub) Step 1: Pull request

Create PR for GEOSgcm to merge feature/<user>/gocart/some-change into develop.

(GitHub) Step 2: Merge and issue v-tag

1. Merge feature/<user>/gocart/some-change into main
2. Create a GEOSgcm v-tag (release) that includes the new change (e.g. v13.4.0)

All done!