blacklight-spotlight 4.0.2 → 4.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -9
  3. data/lib/spotlight/version.rb +1 -1
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6167b9ec0f0c5a6ce1635552497626d450d2556d6313898c53b8ec5b3913d02c
4
- data.tar.gz: 1d695b6673fd753b44b34d0f8d8349f8ebd2a1caf72ef2ee11c43fb8b1a06433
3
+ metadata.gz: 32f18f140c36b39b7bca19c58d24166cddfaf1207a96463b4e9056717f5d4bc2
4
+ data.tar.gz: 9bc8343e689f3bbb28e31d88717f695de88d276ff9a8209a4cf8a3258758d39b
5
5
  SHA512:
6
- metadata.gz: 96742e7e752440d6cb3fab9f8235198ece467572f4f3f33afed9a2333e2451ae9c44b420076a7aad0455deb8f5d02ffd53df81eb5134d1ccec37bc63d0d9ab27
7
- data.tar.gz: f141de9c3be60f2397d186df634d46b45a0cd7073534500786598f6cff8f836296a32d8bd0827c66c1a7eec37636a8e789704f5e5a1b6c559d7a8a61da70931b
6
+ metadata.gz: ec713d378bff4ea14fb1abb60469a3306bb57195b1eaace499830e7f70714f5d8119b0e45377970615bb633184ca9a2cda883f3b65374b0a39702cb653c1015c
7
+ data.tar.gz: b63cb0138dc8117ce84f19b59d074854cb74b5220551f6097b5050ccb1794c288d0f7e60ecec06228a9918c78e70cbac7916c0eda8d0cf18996a42adc85d1815
data/README.md CHANGED
@@ -114,16 +114,24 @@ See [developer-facing instructions for enabling translation](https://github.com/
114
114
  - [Blacklight Development Google group](https://groups.google.com/forum/#!forum/blacklight-development)
115
115
  - [Spotlight Community Group](https://groups.google.com/forum/#!forum/spotlight-community) (equivalent to #spotlight-service)
116
116
 
117
-
118
- ## Building the javascript
119
- The javascript is built by npm from sources in `app/javascript` into a bundle
117
+ ## Updating the JavaScript bundle
118
+ The JavaScript is built by npm from sources in `app/javascript` into a bundle
120
119
  in `app/assets/javascripts/spotlight/spotlight.js`. This file should not be edited
121
- by hand as any changes would be overwritten. When any of the javascript
120
+ by hand as any changes would be overwritten. When any of the JavaScript
122
121
  components in the gem are changed, this bundle should be rebuilt with the
123
122
  following steps:
124
123
  1. [Install npm](https://www.npmjs.com/get-npm)
125
- 2. run `npm install` to download dependencies
126
- 3. make sure that the version in `package.json` matches your intended release version
127
- 4. commit the new `package-lock.json` that reflects the desired version number
128
- 6. run `npm run prepare` to build the bundle
129
- 6. run `npm publish` to push the javascript package to https://npmjs.org/package/spotlight-frontend
124
+ 2. Run `npm install` to download dependencies
125
+ 3. Run `npm run prepare` to build the bundle
126
+ 4. If you are releasing a new version of the gem, follow the release instructions below.
127
+
128
+ ## Releasing a new version and publishing the JavaScript
129
+ You only need to update `package.json` and prepare/publish the JavaScript package for npm if there are changes to the JavaScript.
130
+ 1. Edit `version.rb` and `package.json` to set the new version
131
+ 2. Run `npm run prepare` to build the JavaScript bundle
132
+ 3. Run `npm i --package-lock-only` to update the version in `package-lock.json`
133
+ 4. Commit the changes e.g. `git commit -am "Bump version to X.X.X"`
134
+ 5. Push the release to rubygems and GitHub: `bundle exec rake release`
135
+ 6. Run `npm publish` to push the JavaScript package to https://npmjs.org/package/spotlight-frontend
136
+
137
+ See "Updating the JavaScript bundle" above for more details.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Spotlight
4
- VERSION = '4.0.2'
4
+ VERSION = '4.0.3'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: blacklight-spotlight
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.2
4
+ version: 4.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Chris Beer
@@ -11,7 +11,7 @@ authors:
11
11
  autorequire:
12
12
  bindir: bin
13
13
  cert_chain: []
14
- date: 2024-09-12 00:00:00.000000000 Z
14
+ date: 2024-09-13 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: activejob-status
@@ -1572,7 +1572,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
1572
1572
  - !ruby/object:Gem::Version
1573
1573
  version: '0'
1574
1574
  requirements: []
1575
- rubygems_version: 3.5.9
1575
+ rubygems_version: 3.4.19
1576
1576
  signing_key:
1577
1577
  specification_version: 4
1578
1578
  summary: Enable librarians, curators, and others who are responsible for digital collections