Start using kausal_common

.github/workflows/kausal-ci.yaml → .github/workflows/ci.yaml

@@ -13,11 +13,22 @@ jobs:
       DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
       DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
 
+  # test:
+  #   needs: [build]
+  #   uses: ./.github/workflows/e2e-image.yaml
+  #   with:
+  #     image: ${{ needs.build.outputs.image }}:${{ needs.build.outputs.image_tag }}
+  #     backend_base_url: https://api.paths.kausal.dev
+  #     build_id: ${{ needs.build.outputs.build_id }}
+  #     s3_endpoint: ${{ vars.BUILD_S3_ENDPOINT }}
+  #     s3_bucket: ${{ vars.BUILD_S3_BUCKET }}
+  #   secrets: inherit
+
   deploy:
     needs: [build]
     uses: kausaltech/github-actions/.github/workflows/deploy.yaml@main
     secrets:
-      gitops_pat: ${{ secrets.GHA_GITOPS_PAT }}
+      gitops_ssh_key: ${{ secrets.GITOPS_SSH_KEY }}
     if: needs.build.outputs.deployment_env
     with:
       docker_image_repo: ${{ needs.build.outputs.image }}

.github/workflows/pull-request-ci.yml

@@ -12,17 +12,16 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [20.x]
-
     steps:
       - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
+          submodules: recursive
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
           cache: 'npm'
       - run: npm ci
       - run: npm run lint

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "kausal_common"]
+	path = kausal_common
+	url = https://github.com/kausaltech/kausal-ui-common.git

.nvmrc

@@ -1 +1 @@
-20.6.1
+24

README.md

@@ -28,7 +28,7 @@ Before you begin, ensure you have the following installed on your machine:
 1. **Clone the repository:**
 
    ```sh
-   git clone https://github.com/kausaltech/nzc-data-studio.git
+   git clone --recursive https://github.com/kausaltech/nzc-data-studio.git
    cd nzc-data-studio
    ```
 
@@ -59,7 +59,7 @@ Before you begin, ensure you have the following installed on your machine:
    3. Add the desired API URL depending on your environment, if you're not sure which one to use, check with the Kausal team
 
       ```env
-      KAUSAL_PUBLIC_API_URL=https://<API_URL>.dev
+      PATHS_BACKEND_URL=https://<API_URL>.dev
       ```
 
 ## Development
@@ -96,12 +96,12 @@ The application will be available on [http://localhost:3000](http://localhost:30
 
 Variables prefixed with `KAUSAL_PUBLIC_` are made available client side. When using these environment variables, import them from `@/constants/environment` to support fallbacks.
 
-- `KAUSAL_PUBLIC_API_URL`: Configure the backend URL for Kausal Paths, e.g. a staging or local backend
-- `KAUSAL_PUBLIC_DEPLOYMENT_TYPE`: The deployment type e.g `staging` or `production`
+- `PATHS_BACKEND_URL`: Configure the backend URL for Kausal Paths, e.g. a staging or local backend
+- `DEPLOYMENT_TYPE`: The deployment type e.g `staging` or `production`
 - `AUTH_SECRET`: Secret key used for encrypting tokens and cookies (this can be any random string)
 - `AUTH_CLIENT_ID`: Client ID for authentication
 - `AUTH_CLIENT_SECRET`: Client secret for authentication
-- `KAUSAL_PUBLIC_AUTH_ISSUER`: URL of the authentication issuer; if not set, will use `KAUSAL_PUBLIC_API_URL`
+- `AUTH_ISSUER`: URL of the authentication issuer; if not set, will use `PATHS_BACKEND_URL`
 
 ### Analyzing the Next Bundle
 
@@ -114,11 +114,11 @@ Here is an overview of the project's folder structure:
 ```
 nzc-data-studio/
 ├── public/                # Public assets such as images and fonts
-├── app/                   # Next App Router directory, containing all paths and pages
-├── components/            # React components
-├── theme/                 # Material UI theme overrides
-├── utils/                 # Shared utility functions
-├── store/                 # Shared application state
+├── src/app/                   # Next App Router directory, containing all paths and pages
+├── src/components/            # React components
+├── src/theme/                 # Material UI theme overrides
+├── src/utils/                 # Shared utility functions
+├── src/store/                 # Shared application state
 ```
 
 ### Store