@playpilot/tpi 5.4.0 → 5.5.1

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.
package/README.md CHANGED
@@ -25,8 +25,14 @@ The final build differs largely from the development environment. The developmen
25
25
 
26
26
  The project is published on NPM as a package, but only the final dist file is relevant. This file is included in the repo so that it can be picked up by jsdelivr.net, which we use as a CDN for the script. The url that is presented to clients is a redirect from https://scripts.playpilot.com/link-injection.js to https://cdn.jsdelivr.net/npm/@playpilot/tpi@[version]/dist/link-injections.js. We use a direct version rather than `@latest` to have better control over caching, as `@latest` is cached both on jsdelivr and the end user's browser.
27
27
 
28
- To publish the script follow these steps:
29
- 1. Build the script and commit the new file as a separate commit
30
- 2. Bump the package.json version and commit this change
31
- 3. Publish the script using `npm publish --access public` (or `npm publish --access public --tag next for beta versions)
28
+ The build and publish a new version simply run:
29
+
30
+ ```
31
+ npm run release major|minor|patch
32
+ ```
33
+
34
+ To publish the script manually follow these steps (this is often done for beta versions):
35
+ 1. Build the script using `npm run build, optionally commit the new file as a separate commit
36
+ 2. Bump the package.json version, optionally commit this change
37
+ 3. Publish the script using `npm publish --access public` (or `npm publish --access public --tag next` for beta versions)
32
38
  4. Update redirect rules on Cloudflare to match the new version, which can be found under the "TPI: Latest script version (jsdelivr)" rule (or "TPI: Beta script version (jsdelivr)" for beta versions).