Non-Component Upgrade TRD

[rmenner]

Non-Component Upgrade TRD

Overview

This document outlines the plan to apply current best practices (gitflow, configuration, and docs) to all repositories within the Auro family. It serves as both an audit and an MVP plan to roll out new standards into non-component repositories.

Problem Statement

Current gitflow actions only support repositories with a full suite of features (build, test, localhost demo, versioned releases). The goal is to determine what modifications are needed for each repo to include these features, or to create actions that accommodate repos with fewer features.

Additionally, update package.json and configuration files to use the latest standards where possible.

Out of Scope

• Editing build tools

Solution

• PART 1
  Prioritize developer impacting repos (AuroDesignTokens, WebCoreStyleSheets, auro-element, and icons)
  • Fix docs builder to work with non-component repos.
  • Update README files and add documentation where needed.
  • Ensure test tooling is setup and running.
• PART 2
  Make bare minimum adjustments to all the other repos on the list.
  • Package.json optimization.
  • Basic gitflow setup.
  • Update readme

Repository Audit

Key (✓ available | ⚠️ needs update | ❌ unavailable | )

Repository	Build	Docs	Lint	Tests	Ver	Read	Actions	Priority
cli	✓	❌	✓	❌	✓	⚠️	full
Tokens	✓	✓	❌	✓	✓	✓	full	⭐️
WCSS	✓	✓	✓	✓	✓	✓	full	⭐️
element	✓	✓	✓	✓	✓	⚠️	full	⭐️
icons	✓	✓	✓	✓	✓	✓	full	⭐️
config	❌	❌	✓	❌	✓	✓	no-build
actions	❌	❌	❌	❌	❌	⚠️	no-action
templates	❌	❌	❌	❌	❌	⚠️	no-action
library	❌	❌	✓	✓	✓	✓	no-build

Task List

Prerequisites

• Fix docs builder processes.
• Create new workflows in auro-actions.
• Update auro-templates to include new workflows and adjust folder structure as needed.

---

Priority Repository Checklist

• Run auro-sync with appropriate workflow templates
• Update CDN links
• Add auro-config
• Run new linting
• Update docs builder
• package.json checklist
• Audit testing

Other Repository Checklist

• Run auro-sync with appropriate workflow templates
• package.json checklist

---

package.json Checklist

• Update engines to >=20
• Clean up published files for npm package
• Clean up dependencies
• Update prepare script: change husky install to husky
• Remove configs replaced by auro-config
• Add provenance to publishConfig
• Update version to 0.0.0
• Remove hard-coded contributors section
• Remove postinstall
• Clean up exports

---

Repo-Specific Tasks

auro-cli

• Create docs
• Update README

auro-element (net new)

• Set up basic component project (test/build/demo/release)

icons

• Update namespace to @aurodesignsystem
• Requires separate TRD to cover any updates outside of this TRD

auro-tokendefinitions

• Update README (current version is not accurate)

auro-actions

• Update docs to describe new workflows (no-build, etc.)

auro-templates

• Refactor structure to support auro sync and markdown magic sources
• Consider adding GitHub tagged versions