Merge branch 'main' into updates

Author: idesigncode

.github/workflows/node.js.yml

@@ -8,6 +8,9 @@ on:
   pull_request:
     branches: ['main']
 
+env:
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -24,5 +27,3 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install-test
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/npm-publish.yml

@@ -7,6 +7,10 @@ on:
   release:
     types: [created]
 
+env:
+  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -16,8 +20,6 @@ jobs:
         with:
           node-version: 20
       - run: npm install-test
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
   publish-npm:
     needs: build
@@ -30,5 +32,3 @@ jobs:
           registry-url: https://registry.npmjs.org/
       - run: npm install
       - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/storybook-tests.yml

@@ -10,6 +10,10 @@ on:
   pull_request:
     branches: ['main']
 
+env:
+  NETLIFY_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
+  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -22,16 +26,12 @@ jobs:
           # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
       - name: Install dependencies
         run: npm install
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Wait for Netlify
         uses: probablyup/[email protected]
         id: waitForDeployment
         with:
           site_id: ${{ secrets.NETLIFY_SITE_ID }}
-        env:
-          NETLIFY_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
 
       - name: Run Storybook tests
         run: npm run test:storybook

.gitignore

@@ -19,6 +19,6 @@ __snapshots__/failed/
 
 # Build files
 storybook-static/
-/exampleFunction.mjs
-/exampleStyles.css
-/ExampleComponent.mjs
+/SampleComponent.mjs
+/sampleFunction.mjs
+/sampleStyles.css

README.md

@@ -9,7 +9,7 @@ Quickly setup ESM React repositories with preconfigured functionality.
 
 ## Usage
 
-Remove/replace the example source files in the `src` directory with your own.
+Remove/replace the sample source files in `src` & `stories` with your own.
 
 When adding source files, remember to add the build output file details to the `files` & `exports` fields of [package.json](package.json) and [.gitignore](.gitignore).
 
@@ -46,7 +46,7 @@ The GitHub action [npm-publish.yml](.github/workflows/npm-publish.yml) is used t
 
 #### Code linting tests
 
-The GitHub action [node.js.yml](.github/workflows/node.js.yml) is used to run the code linting tests on pull requests and commit pushes into the main branch.
+The GitHub action [node.js.yml](.github/workflows/node.js.yml) is used to run the code linting tests on pull requests and commit pushes into the main branch. The action requires the `NPM_TOKEN` secrets to be set.
 
 `npm run test` runs the code linting tests:
 
@@ -59,6 +59,7 @@ The GitHub action [storybook-tests.yml](.github/workflows/storybook-tests.yml) i
 
 - `NETLIFY_SITE_ID`
 - `NETLIFY_TOKEN`
+- `NPM_TOKEN`
 
 These Storybook CI tests can also be run while running Storybook locally: