Merge 7f4419a into 7b8b9a6

Author: Jakeii

.changeset/every-feet-bow.md

@@ -0,0 +1,5 @@
+---
+'@guardian/commercial': minor
+---
+
+Test changeset

.github/workflows/beta-release-on-label.yml

@@ -38,7 +38,7 @@ jobs:
         uses: ./.github/actions/setup-node-env
 
       - name: Build package
-        run: pnpm build
+        run: pnpm build:core
 
       - name: Version
         run: pnpm changeset version --snapshot beta

.github/workflows/ci.yml

@@ -52,8 +52,8 @@ jobs:
       - name: Check types
         run: pnpm tsc
 
-  build:
-    name: Build
+  build-bundle:
+    name: Build Bundle
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
@@ -63,17 +63,36 @@ jobs:
         uses: ./.github/actions/setup-node-env
 
       - name: Build package
-        run: pnpm build
+        run: pnpm build:bundle
 
       - name: Save build
         uses: actions/upload-artifact@v4.6.2
         with:
-          name: dist
+          name: bundle-dist
           path: dist
 
-  release:
-    name: Release
-    needs: [build, test, lint, types]
+  build-core:
+    name: Build Core
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4.2.2
+
+      - name: Set up Node
+        uses: ./.github/actions/setup-node-env
+
+      - name: Build package
+        run: pnpm build:core
+
+      - name: Save build
+        uses: actions/upload-artifact@v4.6.2
+        with:
+          name: core-dist
+          path: dist
+
+  changesets:
+    name: Core Changesets
+    needs: [build-core, test, lint, types]
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     steps:
@@ -89,8 +108,8 @@ jobs:
       - name: Fetch build
         uses: actions/download-artifact@v4.3.0
         with:
-          name: dist
-          path: dist
+          name: core-dist
+          path: core/dist
 
       - name: Use GitHub App Token
         uses: actions/create-github-app-token@v2
@@ -108,7 +127,7 @@ jobs:
         id: changesets
         uses: changesets/action@v1.5.3
         with:
-          publish: pnpm changeset publish
+          publish: pnpm --filter @guardian/commercial changeset publish
           title: '🦋 Release package updates'
           commit: 'Bump package versions'
           setupGitUser: false
@@ -117,8 +136,8 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
   riff-raff:
-    name: Upload Riff Raff Artifacts
-    needs: [build, test, lint, types]
+    name: Upload Bundle Riff Raff Artifacts
+    needs: [build-bundle, test, lint, types]
     runs-on: ubuntu-latest
     permissions:
       id-token: write
@@ -138,7 +157,7 @@ jobs:
       - name: Fetch build
         uses: actions/download-artifact@v4.3.0
         with:
-          name: dist
+          name: bundle-dist
           path: dist
 
       - name: Riff-Raff Upload

.github/workflows/compressed-size-action.yml

@@ -21,7 +21,7 @@ jobs:
         uses: preactjs/compressed-size-action@v2
         with:
           repo-token: ${{secrets.GITHUB_TOKEN}}
-          build-script: build:prod
+          build-script: build:bundle
           # having a higher change threshold makes the reporting a little less sensitive and more reliable
           minimum-change-threshold: 50
           # filenames are hashed so we need to strip that, or it thinks we've created new files every build

README.md

@@ -1,19 +1,17 @@
-# @guardian/commercial
+# Commercial Monorepo
 
 This package contains the code for the commercial bundle that is loaded on all pages on theguardian.com.
 
 There are 2 main parts to this repo:
 - The commercial bundle itself, which is a set of javascript files that is loaded on all pages on theguardian.com.
 - Some modules that are used by other parts of the Guardian codebase, such as DCR. This is published as a package to npm, `@guardian/commercial`.
 
-The exported modules are in `src/core`, everything else is part of the commercial bundle.
-
-## Installation
-
-To install the npm package, run `pnpm i @guardian/commercial`.
+The `@guardian/commercial` modules are in `core/src`, everything else is only part of the commercial bundle and not the `@guardian/commercial` package.
 
 ## Development
 
+**For working on the commercial bundle, see below. For working on the `@guardian/commercial` npm package, see [core/README.md](core/README.md).**
+
 ### Requirements
 
 -   Node
@@ -25,15 +23,7 @@ To install the npm package, run `pnpm i @guardian/commercial`.
 
 To install dependencies, run `pnpm`.
 
-To develop locally on the bundle, run `pnpm serve` to start a local server. This will watch for changes and rebuild the bundle. Serving it at `http://localhost:3031`.
-
-### Releasing to NPM
-
-This repository uses [changesets](https://github.com/changesets/changesets) for version management
-
-To release a new version with your changes, run `pnpm changeset add` and follow the prompts. This will create a new changeset file in the `.changeset` directory. Commit this file with your PR.
-
-When your PR is merged, changeset will analyse the changes and create a PR to release the new version.
+To develop the bundle locally on the bundle, run `pnpm serve` to start a local server. This will watch for changes and rebuild the bundle. Serving it at `http://localhost:3031`.
 
 ### Pull requests
 
@@ -89,12 +79,6 @@ To test the bundle on CODE, create a PR, wait for github actions to run and a ri
 
 Although you can deploy CODE changes without deploying Frontend or DCR, it's a good idea to flag any CODE deployments on the dotcom semaphore chat in case it has an effect on anything anyone else is testing.
 
-#### Testing changes to the `@guardian/commercial` npm package
-You can add the [beta] @guardian/commercial label to your pull request, this will release a beta version of the bundle to NPM, the exact version will be commented on your PR.
-
-In order to do this, run `pnpm changeset`. This will create a new changeset file in the .changeset directory. Commit this file with your PR.
-
-Note: Once the beta version is released, the label will be removed from the PR, so you will need to add it again if you want to release subsequent new versions.
 
 ### Deploying to PROD
 

core/README.md

@@ -0,0 +1,45 @@
+# @guardian/commercial
+
+This directory contains the modules that are published as the `@guardian/commercial` npm package.
+
+## Installation
+
+To install the npm package, install with your favourite package manager:
+
+```bash
+pnpm i @guardian/commercial
+yarn add @guardian/commercial
+npm i @guardian/commercial
+```
+
+## Development
+
+build the package with:
+
+```bash
+pnpm build
+```
+
+This will build the package into the `dist` directory, which is what is published to npm.
+
+#### Testing changes to the `@guardian/commercial` npm package
+You can add the [beta] @guardian/commercial label to your pull request, this will release a beta version of the bundle to NPM, the exact version will be commented on your PR.
+
+In order to do this, run `pnpm changeset`. This will create a new changeset file in the .changeset directory. Commit this file with your PR.
+
+Note: Once the beta version is released, the label will be removed from the PR, so you will need to add it again if you want to release subsequent new versions.
+
+## Releasing to NPM
+This repository uses changesets for version management.
+
+To release a new version with your changes, run:
+
+```bash
+pnpm changeset add
+```
+
+and follow the prompts. This will create a new changeset file in the `.changeset` directory. Commit this file with your PR.
+
+When your PR is merged, changeset will analyse the changes and create a PR to release the new version.
+
+if you are part of the `commercial` team, you can merge the changeset PR to release the new version. If you are not part of the `commercial` team, you will need to ask someone who is to merge the PR for you.

core/package.json

@@ -0,0 +1,55 @@
+{
+	"name": "@guardian/commercial",
+	"version": "26.0.0",
+	"description": "Guardian advertising business logic",
+	"homepage": "https://github.com/guardian/commercial#readme",
+	"bugs": {
+		"url": "https://github.com/guardian/commercial/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/guardian/commercial.git"
+	},
+	"license": "Apache-2.0",
+	"files": [
+		"dist"
+	],
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"exports": {
+		".": {
+			"development": "./src/index.ts",
+			"import": "./dist/esm/index.js",
+			"require": "./dist/cjs/index.js"
+		},
+		"./*": {
+			"development": "./src/*.ts",
+			"import": "./dist/esm/*.js",
+			"require": "./dist/cjs/*.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"scripts": {
+		"build": "npm-run-all clean --parallel build:core:*",
+		"clean": "rm -rf dist",
+		"build:core:esm": "tsc --outDir ./dist/esm --project ./tsconfig.esm.json",
+		"build:core:cjs": "tsc --outDir ./dist/cjs --project ./tsconfig.cjs.json",
+		"tsc": "tsc --noEmit"
+	},
+	"peerDependencies": {
+		"@guardian/ab-core": "catalog:",
+		"@guardian/libs": "catalog:"
+	},
+	"dependencies": {
+		"@guardian/ab-core": "catalog:",
+		"@guardian/libs": "catalog:"
+	},
+	"devDependencies": {
+		"@types/node": "catalog:",
+		"typescript": "catalog:"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"packageManager": "pnpm@9.15.2"
+}