@tryghost/announcement-bar 1.1.286 → 1.1.288

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -12
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # Announcement Bar
2
2
 
3
+ Announcement banner injected into Ghost sites.
4
+
3
5
  ## Development
4
6
 
5
7
  ### Pre-requisites
@@ -14,25 +16,28 @@ Start Ghost with the public-app watchers enabled:
14
16
  pnpm dev:public
15
17
  ```
16
18
 
17
- This starts the standard development environment and the Announcement Bar watcher. To run only the package's build watcher, use `pnpm dev` from this directory.
18
-
19
- ## Release
19
+ This starts the standard development environment and the Announcement Bar
20
+ watcher. To work on this package by itself, run these commands from this
21
+ directory:
20
22
 
21
- A patch release can be rolled out instantly in production, whereas a minor/major release requires the Ghost monorepo to be updated and released.
22
- In either case, you need sufficient permissions to release `@tryghost` packages on NPM.
23
+ ```bash
24
+ pnpm build # one-off build
25
+ pnpm dev # watch and rebuild the UMD bundle
26
+ pnpm test # run unit tests once
27
+ pnpm lint # lint source and tests
28
+ ```
23
29
 
24
- ### Patch release
30
+ ## Release
25
31
 
26
- 1. Run `pnpm ship` and select a patch version when prompted
27
- 2. Merge the release commit to `main`
32
+ Patch releases are automatic. When Announcement Bar changes on `main`, CI publishes the next patch version to npm and clears the jsDelivr cache. Sites using that major/minor line receive the patch without a Ghost release.
28
33
 
29
- ### Minor / major release
34
+ For an intentional minor or major release:
30
35
 
31
- 1. Run `pnpm ship` and select a minor or major version when prompted
36
+ 1. From a clean branch, run `pnpm ship` and select a minor or major version
32
37
  2. Merge the release commit to `main`
33
- 3. Wait until a new version of Ghost is released
38
+ 3. Wait for a public Ghost release to ship the new default version line
34
39
 
35
- To use the new version of Announcement Bar in Ghost, update the version in Ghost core's default configuration (currently at `core/shared/config/default.json`)
40
+ `pnpm ship` updates both the package version and Ghost's default Announcement Bar version.
36
41
 
37
42
  # Copyright & License
38
43
 
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@tryghost/announcement-bar",
3
3
  "type": "module",
4
- "version": "1.1.286",
4
+ "version": "1.1.288",
5
+ "description": "Announcement banner for Ghost sites",
5
6
  "license": "MIT",
6
7
  "repository": {
7
8
  "type": "git",