ci: adding pre-release ci for oxygen sdk

Author: joker23

.github/CI_CONTRIBUTING.md

@@ -3,6 +3,77 @@
 This directory contains Github Actions for building, deploying, releasing
 libraries in this monorepo.
 
+## Creating pre-releases modules
+
+The following steps are to create a pre release modules which would walk through the initial
+CI work needed for new SDKs.
+
+### 1. Extend `release-please-config.json`
+
+Add a record of your new SDK package to `packages`
+```
+"PATH_TO_YOUR_PACKAGE": {
+  "bump-minor-pre-major": true,
+  "prerelease": true
+}
+```
+> NOTE: the `PATH_TO_YOUR_PACKAGE` needs to match the path in `package.json`
+> eg `packages/sdk/server-node`
+
+This is the minimum changes you need to do. `bump-minor-pre-major` option means only
+minor version will be incremented while your package is in pre-release state.
+> Pre-release packages **MUST** be in major version `0`
+
+### 2. Add initial release manifest
+
+Add the following to `.release-please-manifest.json`
+```
+"PATH_TO_YOUR_PACKAGE": "0.0.0"
+```
+
+### 3. Add option to manual workflows
+
+Add `PATH_TO_YOUR_PACKAGE` to the `on.workflow_dispatch.inputs.workspace_path.options`
+array in the following files:
+- [`manual-publish-docs.yml`](./workflows/manual-publish-docs.yml)
+- [`manual-publish.yml`](./workflows/manual-publish.yml)
+
+### 4. Create a CI non-release workflow for just the project
+
+You will add a file in the `.github/workflows` directory that tells GHA (mostly) how to
+test your SDK. Below is a simple template to get started:
+```
+name: sdk/YOUR_SDK
+
+on:
+  push:
+    branches: [main, 'feat/**']
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    branches: [main, 'feat/**']
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-YOUR_SDK:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          registry-url: 'https://registry.npmjs.org'
+      - id: shared
+        name: Shared CI Steps
+        uses: ./actions/ci
+        with:
+          workspace_name: YOUR_PACKAGE_NAME
+          workspace_path: PATH_TO_YOUR_PACKAGE
+```
+> NOTE: you should test your configuration on [your local machine](#local-testing-using-act) if
+> possible.
+
 ## Local testing using act
 
 You can use [act](https://nektosact.com/usage/index.html) to run github actions locally for testing.

.github/workflows/manual-publish-docs.yml

@@ -24,6 +24,7 @@ on:
           - packages/sdk/server-ai
           - packages/telemetry/browser-telemetry
           - packages/sdk/combined-browser
+          - packages/sdk/shopify-oxygen
 name: Publish Documentation
 jobs:
   build-publish:

.github/workflows/manual-publish.yml

@@ -40,6 +40,7 @@ on:
           - packages/ai-providers/server-ai-langchain
           - packages/telemetry/browser-telemetry
           - packages/sdk/combined-browser
+          - packages/sdk/shopify-oxygen
       prerelease:
         description: 'Is this a prerelease. If so, then the latest tag will not be updated in npm.'
         type: boolean

.github/workflows/shopify-oxygen.yml

@@ -0,0 +1,28 @@
+name: sdk/shopify-oxygen
+
+on:
+  push:
+    branches: [main, 'feat/**']
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    branches: [main, 'feat/**']
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-shopify-oxygen:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          # https://shopify.dev/docs/storefronts/headless/hydrogen/getting-started#requirements
+          node-version: lts/*
+          registry-url: 'https://registry.npmjs.org'
+      - id: shared
+        name: Shared CI Steps
+        uses: ./actions/ci
+        with:
+          workspace_name: '@launchdarkly/shopify-oxygen-sdk'
+          workspace_path: packages/sdk/shopify-oxygen

.release-please-manifest.json

@@ -21,5 +21,6 @@
   "packages/store/node-server-sdk-redis": "4.2.14",
   "packages/telemetry/browser-telemetry": "1.0.11",
   "packages/telemetry/node-server-sdk-otel": "1.3.2",
-  "packages/tooling/jest": "0.1.12"
+  "packages/tooling/jest": "0.1.12",
+  "packages/sdk/shopify-oxygen": "0.0.0"
 }

CONTRIBUTING.md

@@ -235,7 +235,7 @@ There are a number of categories of packages in the monorepo:
 5. **Tooling packages** (red): Development and testing tools
    - Jest testing utilities
 
-### Depenencies
+### Dependencies
 
 In general dependencies should be avoided unless they are absolutely necessary. For each dependency several considerations should be made:
 

packages/sdk/shopify-oxygen/tsconfig.ref.json

@@ -1,10 +1,7 @@
 {
-  "extends": "../../../tsconfig.json",
+  "extends": "./tsconfig.json",
   "compilerOptions": {
     "composite": true,
-    "rootDir": ".",
-    "outDir": "dist"
   },
-  "include": ["src/**/*.ts"],
-  "exclude": ["**/*.test.ts", "dist", "node_modules", "__tests__", "example"]
+  "include": ["src/**/*", "package.json"],
 }

packages/sdk/shopify-oxygen/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs"
+}

release-please-config.json

@@ -12,6 +12,13 @@
       "bump-minor-pre-major": true,
       "prerelease": true
     },
+    "packages/sdk/shopify-oxygen": {
+      "bump-minor-pre-major": true,
+      "prerelease": true,
+      "extra-files": [
+        "src/platform/OxygenInfo.ts"
+      ]
+    },
     "packages/shared/common": {},
     "packages/shared/sdk-client": {},
     "packages/shared/sdk-server": {},

tsconfig.json

@@ -87,6 +87,9 @@
     },
     {
       "path": "./packages/ai-providers/server-ai-vercel/tsconfig.ref.json"
+    },
+    {
+      "path": "./packages/sdk/shopify-oxygen/tsconfig.ref.json"
     }
   ]
 }