From a221d153f4bdd0d00f90f74d6e75e9141e511a30 Mon Sep 17 00:00:00 2001 From: Rhyne Vlaservich Date: Sat, 25 Dec 2021 14:36:16 -0500 Subject: [PATCH] Add docs for distributing --- DISTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 DISTRIBUTING.md diff --git a/DISTRIBUTING.md b/DISTRIBUTING.md new file mode 100644 index 0000000..25471dc --- /dev/null +++ b/DISTRIBUTING.md @@ -0,0 +1,14 @@ +For distributing a new version to Github, NPM, and the CDN + +1. Ensure the build is up to date with `npm run build` +2. Update all version numbers in the app using [Semantic Versioning](https://semver.org/). Ex renaming `1.8.0` to `1.8.1` for a patch. + 1. package.json + 2. package-lock.json + 3. docs/content/_index.md +3. Create commit of the new version with the changed version files: `v1.8.3` +4. Push to master +5. Create new release in the Github UI + 1. Create a new tag with the same name as the commit: `v1.8.3` + 2. Add details about the additions and fixes + 3. Upload the files in `dist` to the "Attach Binaries" section (`paper.css` and `paper.min.css`) +6. Publish to NPM with `npm publish`. The CDN will automatically pick up the new files