This repository is a modernisation fork of the Australian Government Design System components. The upstream service was decommissioned in 2020; to keep long-running programmes unblocked we migrated the code to the TrueCMS GitHub organisation, continue to publish under the new @truecms npm scope, and mirror the legacy @gov.au/* tags so existing consumers remain supported.

This migration allows the maintainers to provide funded support for agencies and vendors who still rely on the original component APIs. Active development now happens in the open under the TrueCMS banner, but compatibility guarantees, accessibility goals, and public licensing remain unchanged.

• Production preview site: https://design-system-components.truecms.com.au/
• Pull requests trigger Cloudflare preview builds linked from the Checks tab.
• Contributor guides live under docs/ with focused walkthroughs for publishing, Drupal integration, and migration steps.

Earlier Node releases are no longer supported. Automated workflows and published packages declare these engine constraints to prevent accidental installs on unsupported runtimes.

1. Use nvm (or your preferred version manager) to select Node 22:

   nvm install 22
   nvm use 22

2. Enable Corepack so pnpm 9 is available:

   corepack enable
   corepack prepare pnpm@9 --activate

3. Install workspace dependencies and refresh the lockfile:

   pnpm run bootstrap

4. Build the component suites:

   pnpm run build

5. Execute the full verification sweep (Jest unit tests, Pa11y accessibility, helper smoke tests, and bundle parity checks):

   pnpm run test

6. For targeted component checks you can scope commands, for example pnpm --filter @truecms/buttons run build.

All scripts assume Node 22. Running them under earlier versions will emit EBADENGINE warnings or fail during dependency installation.

Refer to CONTRIBUTING.md for details on invoking these workflows manually during reviews.

Releases are orchestrated with Changesets and pnpm:

1. Collect changes using pnpm changeset and merge the generated markdown files.
2. When ready to publish, trigger the npm Release workflow from the GitHub Actions tab. Supply dry_run=false once a release candidate is approved, or keep the default true for validation.
3. The workflow runs pnpm run build, pnpm run test, pnpm run build:site-dist, and pnpm run release (Changesets publish) before pushing tags to npm under the selected scope.
4. Release artefacts are mirrored to the legacy @gov.au/* names via npm dist-tags so downstream teams can opt in at their own pace.

Maintaining parity with Drupal 11 sites is a project requirement. The docs/drupal.md smoke guide documents the verification routine we run before each release: rebuild components on Node 22, publish local tarballs with pnpm, install them into a Drupal 11 sandbox, and manually exercise canonical pages (navigation, accordions, alerts, tables). Workflow issues that threaten Drupal compatibility are triaged with the same urgency as Node runtime regressions.

Open issues or questions on the GitHub issue tracker. The modernization maintainers triage Node compatibility reports twice weekly and follow the escalation path documented in SUPPORT.md to keep FR-005 monitoring requirements in place.

• packages/ – component packages, each with its own README and CHANGELOG.
• scripts/ – build helpers for Sass/PostCSS, accessibility automation, and migration tooling.
• .github/workflows/ – Install Check, Cloudflare Pages, and npm Release pipelines.
• specs/001-already-began-task/ – design artefacts driving the Node 22 initiative (plan, research, tasks, and checklists).
• docs/ – platform-specific guides such as Drupal integration, publishing, and migration from the legacy namespace.

For additional implementation context, see docs/wiki/node-22-modernisation.md and the research log in specs/001-already-began-task/research.md.