Align main to develop

src/js/plugins/qgds-plugin-build-log.js → .esbuild/plugins/qgds-plugin-build-log.js

@@ -23,7 +23,7 @@ export default function buildlog() {
         console.log("CREATED:");
         log("magenta", `CSS\t\t./dist/assets/css/qld.bootstrap.css`);
         log("blue", "JS\t\t./dist/assets/js/bootstrap.min.js");
-        log("blue", `JS\t\t./dist/assets/js/main.js`);
+        log("blue", `JS\t\t./dist/assets/js/qld.bootstrap.min.js`);
 
         //List new components
         const root = process.cwd();

src/js/plugins/qgds-plugin-clean-output-folders.js → .esbuild/plugins/qgds-plugin-clean-output-folders.js

@@ -7,7 +7,7 @@ export default function cleanFoldersPlugin() {
     setup(build) {
       build.onStart(() => {
         //Console feedback
-        log("cyan", `\u{1F4C2} Cleaning /dist and /docs folders\n\n`);
+        log("cyan", `\u{1F4C2} Cleaning /dist folders\n\n`);
 
         // Clean the output folders
         const { outdir, outfile } = build.initialOptions;
@@ -20,11 +20,11 @@ export default function cleanFoldersPlugin() {
           fs.rmSync(outfile);
         }
 
-        // Clean the docs folder
-        const docsdir = "./docs/";
-        if (fs.existsSync(docsdir)) {
-          fs.rmSync(docsdir, { recursive: true });
-        }
+        // // Clean the docs folder
+        // const docsdir = "./docs/";
+        // if (fs.existsSync(docsdir)) {
+        //   fs.rmSync(docsdir, { recursive: true });
+        // }
       });
     },
   };

src/js/plugins/qgds-plugin-copy-assets.js → .esbuild/plugins/qgds-plugin-copy-assets.js

@@ -13,9 +13,19 @@ export default function copyPlugin() {
         from: ["./src/components/bs5/**/*.hbs"],
         to: ["./dist/components/bs5/"],
       },
+      {
+        from: ["./src/components/bs5/**/*.data.json"],
+        to: ["./dist/sample-data/"],
+      },
+      {
+        from: ["./src/js/handlebars*"],
+        to: ["./dist/assets/js"],
+      },
+      {
+        from: ["./src/js/handlebars*"],
+        to: ["./dist/components/"],
+      },
       { from: ["./src/assets/img/*"], to: ["./dist/assets/img"] },
-      { from: ["./dist/**/*"], to: ["./docs/"] },
-      { from: ["./storybook-static/**/*"], to: ["./docs/storybook-static/"] },
     ],
   });
 

.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  versioning-strategy: increase
+  directory: "/"
+  target-branch: "develop"
+  schedule:
+    interval: daily
+    time: "19:00"
+  groups:
+    storybook:
+      patterns:
+        - "@storybook/*"
+        - storybook
+  open-pull-requests-limit: 10
+  reviewers:
+  - qld-gov-au/qld-online-dev-team

.github/release.yml

@@ -0,0 +1,32 @@
+# .github/release.yml
+# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
+# https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels
+
+changelog:
+  categories:
+    - title: Breaking Changes 🛠
+        labels:
+          - Semver-Major
+          - breaking-change
+
+    - title: 🏕 Features
+      labels:
+        - '*'
+      exclude:
+        labels:
+          - dependencies
+          - bug
+          - Semver-Major
+          - breaking-change
+        authors:
+          - dependabot[bot]
+
+    - title: 🐛 Bug Fixes
+      labels:
+        - bug
+
+    - title: 👒 Dependencies
+      labels:
+        - dependencies
+      authors:
+        - dependabot[bot]

.github/workflows/Storybook-library-update.yml

@@ -0,0 +1,110 @@
+name: Update Storybook package.json items
+on:
+  schedule:
+    # * is a special character in YAMLso you have to quote this string
+    - cron:  '0 1 * * *'
+  workflow_dispatch:
+    inputs:
+      description:
+        description: 'Manual run of update Libs'  
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write #Work with the contents of the repository. For example, contents: read permits an action to list the commits, and contents: write allows the action to create a release.
+  #pages: write #Work with GitHub Pages. For example, pages: write permits an action to request a GitHub Pages build.
+  actions: read #Work with GitHub Actions. For example, actions: write permits an action to cancel a workflow run.
+  id-token: write #Fetch an OpenID Connect (OIDC) token. This requires id-token: write.
+  pull-requests: write #Work with pull requests. For example, pull-requests: write permits an action to add a label to a pull request.
+
+jobs:
+  updateLibs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: "develop"
+
+      - name: Cache node modules
+        id: cache-npm
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-node-modules
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
+        name: List the state of node modules
+        continue-on-error: true
+        run: npm list
+
+      # run script in prem, extract to lib, update versions.txt on each file
+      - name: list folder
+        run: |
+          pwd
+          ls -ltr
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Install
+        run: | # Install packages
+          npm install --prefer-offline --no-audit --ignore-scripts
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NEXUSREADONLY2NPMTOKEN }}
+
+      # `npm rebuild` will run all those post-install scripts for us.
+      - name: rebuild and prepare
+        run: npm rebuild && npm run prepare --if-present
+
+      - name: List versions
+        run: | # List versions
+          npm view storybook versions
+
+      - name: What changed
+        run: |
+         export outdated="`npm outdated --parsable `"
+
+         echo '### Outdated' >> $GITHUB_STEP_SUMMARY
+         echo "$outdated" >> $GITHUB_STEP_SUMMARY
+         echo '' >> $GITHUB_STEP_SUMMARY
+
+
+         echo 'OUTDATED_LIST<<EOF' >> $GITHUB_OUTPUT
+         echo "$outdated" >> $GITHUB_OUTPUT
+         echo 'EOF' >> $GITHUB_OUTPUT
+
+         echo "OUTDATED_VERSION<<EOF" >> $GITHUB_OUTPUT
+         npm outdated --parsable|grep ^storybook|awk '{ print $4 }' >> $GITHUB_OUTPUT
+         echo 'EOF' >> $GITHUB_OUTPUT
+         echo $outdated|grep ^storybook|awk '{ print $4 }'
+        id: what-changed-data
+
+      - name: Update package.json ${{ steps.what-changed-data.outputs.OUTDATED_VERSION }}
+        run: | # Update storybook
+          npx storybook@latest upgrade  -y 
+      - name: Install latest
+        run: | # Install packages https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#use-private-packages
+          npm install --no-audit --ignore-scripts
+
+
+      # `npm rebuild` will run all those post-install scripts for us.
+      - name: rebuild and prepare
+        run: npm rebuild && npm run prepare --if-present
+
+        # todo work out how to extract 'outdated' to be commit message
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "update storybook js libraries \r\n ${{ steps.what-changed-data.outputs.OUTDATED_LIST }}"
+          title: "update storybook ${{ steps.what-changed-data.outputs.OUTDATED_VERSION }}"
+          body: "update storybook \r\n ### Please Manually close pull requests and immediately reopen them. This will enable on: pull_request workflows to run and be added as checks. \r\n ${{ steps.what-changed-data.outputs.OUTDATED_LIST }}"
+          branch: "update-storybook-libraries-${{ steps.what-changed-data.outputs.OUTDATED_VERSION }}"
+          base: develop

.github/workflows/compile.js.yml

@@ -14,16 +14,21 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
+    env:
+      HAVE_CHROMATIC_PROJECT_TOKEN: ${{ secrets.CHROMATIC_PROJECT_TOKEN != '' }}
+      IS_CHROMATIC_DISABLED: ${{ vars.CHROMATIC_DISABLED == 'True' }}
     strategy:
       matrix:
         node: [ '20' ]
     name: Lint, Test, Build and Deploy on Node ${{ matrix.node }}
     steps:
-      - uses: actions/checkout@v4.1.2
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Cache node modules
         id: cache-npm
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: cache-node-modules
         with:
@@ -69,21 +74,11 @@ jobs:
       - name: Build 🔧
         run: | # build the files
           npm run build
-#      - name: Build storybook 🔧
-#        run: | # build the Storybook files
-#          npm run build-storybook
-
-      - name: setup Package
-        run: |
-          ls -ltr
-          mkdir -p ./target/docs
-          cp -r ./docs ./target/docs
-          cp -r ./dist ./target/dist
 
       - uses: actions/upload-artifact@v4.3.1
         with:
           name: Package
-          path: ./target
+          path: ./dist
 
 
       - name: Extract branch name
@@ -127,8 +122,31 @@ jobs:
       - name: Build Storybook 🔧
         run: | # build the Storybook files
           npm run build-storybook
+
+      - name: Publish to Chromatic
+        if: ${{ github.actor != 'dependabot[bot]' && env.HAVE_CHROMATIC_PROJECT_TOKEN == 'true' && env.IS_CHROMATIC_DISABLED == 'false'}}
+        uses: chromaui/action@latest
+        # Options required to the GitHub Chromatic Action
+        with:
+          # 👇 Chromatic projectToken, refer to the manage page to obtain it.
+          token: ${{ secrets.GH_TOKEN }}
+          projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
+          # 👇 tell Chromatic to rebuild the entire project when a file matching the pattern is changed https://www.chromatic.com/docs/github-actions/#enable-turbosnap
+          #externals: |
+          #  *.sass
+          #  public/**
+          onlyChanged: true # 👈 Required option to enable TurboSnap
+          storybookBuildDir: "storybook-static"
+      - name: Publish to Chromatic - Is Skipped
+        if: ${{ env.HAVE_CHROMATIC_PROJECT_TOKEN != 'true' }}
+        run: |  
+          echo "### Chromatic not configured" >> $GITHUB_STEP_SUMMARY
+          echo "secrets.CHROMATIC_PROJECT_TOKEN not existing, chromatic did not publish" >> $GITHUB_STEP_SUMMARY
+          echo "If this is a fork, please setup your own personal chromatic at" >> $GITHUB_STEP_SUMMARY
+          echo "[chromatic setup](https://www.chromatic.com/setup)" >> $GITHUB_STEP_SUMMARY
+
       - name: Package storybook files
         uses: actions/upload-artifact@v4 #provide nice artifact
         with:
           name: Storybook
-          path: storybook-static
+          path: storybook-static