@civicactions/cmsds-open-data-components 3.7.0-alpha.1 → 3.7.0-alpha.3

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
@@ -11,9 +11,25 @@ In the root folder for this project, run `npm run watch` to build local code. En
11
11
 
12
12
  ## Publishing new versions
13
13
 
14
- Run ```npm run build``` to create a production version of the library before publishing to npm.
14
+ ### Clear out caches and previous build
15
+
16
+ Before running a build, it is recommended to clear out the old build and cache files to avoid publishing a stale build.
17
+
18
+ Run ```rm -rf dist/``` to delete the previous build\
19
+ Run ```rm -rf .parcel-cache/``` to clear out the parcel build caches
20
+
21
+ ### Create a new release
22
+
23
+ Run ```npm run build``` to create a production version of the library before publishing to npm.\
15
24
  Run ```npm publish``` to publish to npm
16
25
 
26
+ ### Create an alpha/testing release
27
+
28
+ When creating an alpha release or any other release intended for testing purposes, add a tag to the publish command. This will prevent the testing release from showing up as the latest release in NPM.
29
+
30
+ After running ```npm run build```,\
31
+ Run ```npm publish --tag <tag name>``` example (npm publish --tag "alpha")
32
+
17
33
  ## Testing
18
34
 
19
35
  Jest tests can be run using: