Found versions and update tasks
How EasyCode finds the design system version each product is on and keeps one update task per product and system.
In the pilot
The design system module is in the pilot. It is on for pilot orgs first. An org admin can tell you whether yours has it.
A product declares which design system it uses and which version it pins. The found version is what its code actually holds. EasyCode reads it from the code itself, compares it with the system's releases, and keeps one update task per product and system while the product is behind.
Before you start:
- Your org needs the
designmodule and a code index (the knowledge scan). When staff turn off thedesignkill switch, found versions and update tasks are unavailable. See kill switches and modules. - The product must declare the system under Systems it uses on its Design system tab. A maintainer of the product, or an org admin, declares it.
- Found versions come from a knowledge scan, which runs in the desktop app. See set up knowledge.
How the found version is read
How EasyCode reads the version depends on how the product takes the system, the How it takes it you chose when you declared it:
package: from the lockfile. EasyCode readspnpm-lock.yamland npm'spackage-lock.json(version 2 or later) and matches the locked version to the system's release. With several locked versions it shows the lowest. With no lockfile it can read, the version is unknown and the declared range is shown.workspace: the system lives in the same repo, so the product is always on its head.registryorcopy: the UI files copied into the repo, such as components added from a registry, are compared with each release's files. Formatting changes like quotes, semicolons and line wrapping don't count. Each file is exact, drifted (edited, but still close to a release's file) or unknown.submodule: the tag at the commit the submodule pins. A pin that is not on a tag is unknown.runtimeortheme: these can't be read from the code, so they read "Declared, not detectable yet".
Read a product's found version
Open the product and go to its Design system tab.
Find the card named after the system, ending in "Found version".
Read how it was found, the found version, its state and the latest release. A line says "Up to date" or how many releases behind it is.
For copied-in UI, the card also counts files exact, drifted and unknown. When files drifted, Drifted files lists them with the component each one matches and how close it is. The paths show only for repos you can read on GitHub.
The same card shows on the system's Consumers page for each product. See the audit and the adoption number.
The update task
When a design system is marked Required and a product falls behind its latest release, EasyCode opens an update task for that product. It does so only when the gap changes a component the product uses. A system that is not required, or a release that touches nothing the product uses, opens no task.
The task's title names the system and the gap, such as "Update Northwind UI: v1.0.0 to v1.1.0". Its description gives:
- the found version and how it was found, and the latest release;
- each component the product uses that changed, with what changed (props added, removed or changed, a new status);
- the number of token changes;
- how many files drifted from the found version, such as "1 file drifted from v1.0.0";
- a link to the release.
There is one open update task per product and system, never more. When the system tags a newer release, EasyCode rewrites the same task: "v1.0.0 to v1.1.0" becomes "v1.0.0 to v1.2.0". The status and the assignee stay as they were. EasyCode owns the title and description, so you can't edit them.
When a later scan finds the product on the latest release, the task is marked done. If you cancel a task, EasyCode does not reopen it for that release; the next release opens a new one.
Do the update
Open the task, from your work list or from Open update task on the product's Design system tab.
Assign it if it has no assignee yet. See workflows and the board.
Press Start update. In the desktop app it starts a session on the task. On the web it opens the task in your desktop app.
Open the bump pull request in the product's repo. Name the system's package or repo in its title or branch, such as "Bump @northwind/ui-react".
EasyCode links an open pull request in the product's repo to the update task when its title or branch names the system's package or repo. The task's card then shows Open with the pull request's number in place of Start update, and the found version card says the bump pull request is open. EasyCode itself never opens a pull request or writes to GitHub for an update.
Once the bump is merged and the next scan finds the product on the latest release, the task closes by itself.
Related
Something wrong or missing? Suggest a change
The audit and the adoption number
What each product uses from your design systems: the audit of a repo's UI, hand-typed values by file and line, and the adoption counts.
Docs from the record
Generate component and token docs from a design system release, preview them and publish them to your docs repo.