Skip to content

Commit

Permalink
Merge branch 'grahamalama-adr-diagrams' into adr-release-admin-ui
Browse files Browse the repository at this point in the history
  • Loading branch information
leplatrem committed Jan 11, 2024
2 parents 3c6b1c8 + e96919e commit 7e0879a
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/adr/adr_002_packaging_releasing_admin_UI.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ Currently, in order to deliver a change on the Kinto Admin UI to our Remote Sett
4. Upgrade the Kinto version in Remote Settings
5. Release and deploy Remote Settings

```mermaid
sequenceDiagram
actor dev
dev->>Kinto Admin: Tag release
dev->>Kinto: Update Kinto Admin VERSION file
dev->>Kinto: Tag release
Kinto->>PyPI: Build with new Kinto Admin, release to PyPI
Dependabot->>Remote Settings: Bump Kinto
dev->>Remote Settings: Tag release
Remote Settings->>Prod: Build with new Kinto, release to prod
```

Each step can take a certain amount of time, since they may involve pull-requests, review, and coordination.

We want to reduce the amount of time and efforts that are necessary for a change in the Kinto Admin UI repository to be deployed and available to our production users.
Expand Down Expand Up @@ -69,6 +81,16 @@ The releasing steps would become:
2. Upgrade the Kinto Admin version in Remote Settings
3. Release and deploy Remote Settings

```mermaid
sequenceDiagram
actor dev
dev->>Kinto Admin: Tag release
dev->>Remote Settings: Update Kinto Admin VERSION file
dev->>Remote Settings: Tag release
Remote Settings->>Remote Settings: Build RS container, overwriting bundle in kinto Python package with new Kinto Admin
Remote Settings->>Production: release to prod
```

**Delivery Efforts**: Mid. 2 release steps.

**Complexity**: Low. But ungraceful because of the coupling between the location where Kinto expects the assets to be and the Remote Settings repository
Expand All @@ -84,6 +106,16 @@ In Remote Settings, we would set it to a local folder (eg. `KINTO_ADMIN_ASSETS_L

The releasing steps are the same as *Option 1*.

```mermaid
sequenceDiagram
actor dev
dev->>Kinto Admin: Tag release
dev->>Remote Settings: Update Kinto Admin VERSION file
dev->>Remote Settings: Tag release
Remote Settings->>Remote Settings: Build RS container, saving new Kinto Admin to KINTO_ADMIN_ASSETS_LOCATION
Remote Settings->>Production: release to prod
```

**Pros**

- Same as *Option 1*
Expand Down
4 changes: 4 additions & 0 deletions tests/browser_test.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import time

import pytest
from kinto_http.patch_type import JSONPatch
from selenium.common.exceptions import NoSuchElementException
Expand Down Expand Up @@ -65,6 +67,8 @@ async def test_review_signoff(
)
selenium.refresh()

time.sleep(1) # give react a second for hooks

try:
approve_button: WebElement = selenium.find_element(
By.XPATH, "//button[contains(., 'Approve')]"
Expand Down

0 comments on commit 7e0879a

Please sign in to comment.