@guardian/ophan-tracker-js 2.0.3 → 2.0.4

package/build/transmit.js

@@ -2,7 +2,7 @@
 var buildQueryString, bumpViewId, generatePageViewId, isDefined, opanRemoteHost, ref, ref1, ref2, send, sendInitial, sendMore, smartEncode, viewId,
   hasProp = {}.hasOwnProperty;
 
-opanRemoteHost = (typeof window !== "undefined" && window !== null ? window.opanRemoteHost : void 0) || "//ophan.theguardian.com";
+opanRemoteHost = (typeof window !== "undefined" && window !== null ? window.opanRemoteHost : void 0) || "https://ophan.theguardian.com";
 
 generatePageViewId = function() {
   return new Date().getTime().toString(36) + 'xxxxxxxxxxxx'.replace(/x/g, function() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/ophan-tracker-js",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "type": "module",
   "engines": {
     "node": ">=16"

package/readme.md

@@ -22,9 +22,7 @@ $ npm install ophan-tracker-js
 2. In one terminal window:
 
     ```
-    .../ophan/tracker-js $ grunt
-    .../ophan/tracker-js $ grunt watch
-
+    .../ophan/tracker-js $ npm run coffee-to-esm:watch
     ```
 
 3. In another terminal window:
@@ -50,46 +48,22 @@ to localhost 8000. (For me FoxyProxy needed a few switches on and off before it
 
 When you make a change to Tracker JS, you must release on *both* these systems:
 
-* The NPM package [`@guardian/ophan-tracker-js`](https://www.npmjs.com/package/ophan-tracker-js), commonly used on internally developed Guardian sites like Guardian Frontend and Support Frontend.
-* [https://j.ophan.co.uk/](https://j.ophan.co.uk/jobs.js) - CDN/S3, [deployed through RiffRaff](https://riffraff.gutools.co.uk/deployment/history?projectName=ophan%3A%3Aophan-tracker-js&page=1) and used by some Guardian sites like https://jobs.theguardian.com/. An advantage of this approach is that sites using it immediately get Tracker JS updates, without developer intervention.
-
-**Ensure that before you merge a change, you first bump the version in `package.json`. Please make sure you update the [changes.md](changes.md) file too. If you have added a new Ophan client to support a new platform, please add the path to the built output file to the files list in [`package.json`](https://github.com/guardian/ophan/blob/main/tracker-js/package.json#L4).**
-
-### Publish to NPM
-
-Whenever the Tracker script is changed, [its `ophan-tracker-js` NPM package](https://www.npmjs.com/package/ophan-tracker-js/access) will 
-need to be updated to a new version. 
-
-If you don't already have an NPM account, be sure to set up two-factor authentification.
+##### NPM
 
-**Log into NPM**
+We use `changesets` for automated publishing of the NPM package:
 
-```
-$ npm login
-```
-
-**Compile**
-
-```
-.../ophan/tracker-js $ npm install
-```
+1. Add a changeset, run the following command and follow the instructions
 
-**Publish**
+    ```
+    .../ophan/tracker-js $ npx changeset
+    ```
 
-```
-.../ophan/tracker-js $ npm publish
-```
+2. When you raise a PR, the changeset bot won’t correctly see that you have included a changeset – it only checks for the .changesets folder in the root of the repository, whereas we have it in a subdirectory. Don’t worry.
+   
+3. When the PR is merged, the [`changesets` github action](https://github.com/changesets/action) will create a new PR, [example here](https://github.com/guardian/ophan/pull/5626). On merging this generated PR, the action will publish to NPM. (This checks the subdirectory correctly.)
 
-**You will need to be added as an owner of `ophan-tracker-js`. To find the current owners:**
+_Note:_ This seems like an unnecessary extra step and another PR to merge. This action is useful for multi-package repos, and packages with more frequent changes where it consolidates changes from multiple PR's into a single release. This therefore does not apply to us, but we've had issues publishing straight to NPM via the initial action on merge to main.
 
-```
-$ npm owner ls @guardian/ophan-tracker-js 
-```
+##### S3 Bucket
 
-**To add someone as an owner:**
-
-```
-npm owner add npm.username @guardian/ophan-tracker-js
-```
-
-More information on setting owners is available in [NPM's documentation](https://docs.npmjs.com/cli/v7/commands/npm-owner).
+* [https://j.ophan.co.uk/](https://j.ophan.co.uk/jobs.js) - CDN/S3, [deployed through RiffRaff](https://riffraff.gutools.co.uk/deployment/history?projectName=ophan%3A%3Aophan-tracker-js&page=1) and used by some Guardian sites like https://jobs.theguardian.com/. An advantage of this approach is that sites using it immediately get Tracker JS updates, without developer intervention.