@internetarchive/bookreader 5.0.0-94 → 5.0.0-95

package/.github/workflows/npm-publish.yml

@@ -1,5 +1,5 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+# For more information see: https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-nodejs-packages
 
 name: Node.js Package
 
@@ -8,18 +8,7 @@ on:
     types: [created]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm ci
-      - run: npm test
-
   publish-npm:
-    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -28,6 +17,7 @@ jobs:
           node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: npm ci
+      - run: npm run build
       - run: npm publish --tag next
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 5.0.0-95
+- Breaking change: Remove BookReader/ build directory from repo @cdrini
+  - This pattern has become increasingly rare (even jQuery is no longer doing this). If someone was relying on this somehow, you should be able to achieve the same effect using unpkg, or jsdelivr, or similar, eg:
+    - https://unpkg.com/@internetarchive/bookreader@5.0.0-94/BookReader/BookReader.js
+    - https://cdn.jsdelivr.net/npm/@internetarchive/bookreader@5.0.0-94/BookReader/BookReader.js
+    - And so on.
+
 # 5.0.0-94
 - Refactor: Make bookreader package type: module @cdrini
 - Fix: Search icon being fetched from wrong path @cdrini

package/README.md

@@ -147,8 +147,6 @@ The Fragment Change message is sent to the parent window when the embedded BookR
 
 The source JavaScript is written in ES6 (located in the `src/js` directory) and in ES5 (located in `BookReader`). `npm run serve-dev` starts an auto-reloading dev server, that builds js/css that has been edited at `localhost:8000`.
 
-Until the next major version bump, we have to store the build files inside the repo to maintain backwards compatibility. Please _DO NOT_ include these files in your PR. Anything in the `BookReader/` directory should not be committed.
-
 ### Developing icons
 To see local icon package changes in bookreader, you'll need to install core-js into the icon package and link into bookreader.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-94",
+  "version": "5.0.0-95",
   "description": "The Internet Archive BookReader.",
   "type": "module",
   "repository": {

package/scripts/version.js

@@ -19,9 +19,6 @@ async function main() {
 
     // build
     execSync('npm run build', { stdio: "inherit" });
-
-    // Add build files
-    execSync('git add ./BookReader');
 }
 
 main().then(() => process.exit());