From cac5300883501b61bab357c84871207deb2d4619 Mon Sep 17 00:00:00 2001 From: Tjeerd Stap <64895800+ThisIsTJ@users.noreply.github.com> Date: Thu, 27 Aug 2026 12:55:57 -0700 Subject: [PATCH 1/2] Name Coded Apps `-workshop-` The shape was never written down as a rule, only implied by the slug-budget arithmetic, and the two places that did spell a pattern out both spelled a different one. `agents/base.md` and `init.mjs` documented `workshop--local`; every one of the five repos actually used `-workshop-local`, so the documented form had zero users. The template scaffolded the documented form, which is how it would have reached the next five-to-seven workshops. The rule is now explicit: product slug, the literal `workshop`, then the target. `ixp-workshop-growth`, `case-management-workshop-local`. The variable part goes last so every app for one product sorts together. The old environment-first shape (`growth-ixp-workshop`) is retired, and no new `staging` targets: the single existing one predates the rule. The slug budget survives unchanged at 15 characters, with cleaner arithmetic: `-workshop-` spends 10 of 32, leaving 22 to share, and reserving 7 for the target name caps the slug at 15. `init` no longer prints a `staging` row. Not changed: `deriveCodedAppName` still produces `-`, which does not match this convention. It is inert -- no content repo sets `productSlug`, so every target names itself explicitly -- and reshaping derivation changes live URLs, so it belongs in the deliberate derived-names pass rather than here. `base.md` now says so instead of leaving the two shapes to be discovered as a contradiction. Co-Authored-By: Claude Opus 5 --- agents/base.md | 31 ++++++++++++++++++--------- src/commands/init.mjs | 16 +++++++------- template/config/workshop-targets.json | 2 +- 3 files changed, 30 insertions(+), 19 deletions(-) diff --git a/agents/base.md b/agents/base.md index d9aece3..cf5df97 100644 --- a/agents/base.md +++ b/agents/base.md @@ -30,6 +30,13 @@ change the convention here and roll it out everywhere. into the same list. A `## Recap` after it is optional, for a short narrative wrap-up where one genuinely adds something. An up-front `## Requirements` or `## Objectives` section is a different thing and may stay. +- **A Coded App is named `-workshop-`.** The product slug first, + then the literal `workshop`, then the target it is built for: `ixp-workshop-growth`, + `case-management-workshop-local`, `comms-mining-workshop-growth`. The variable + part goes last so that every app for one product sorts together and reads as the + same workshop. Do not put the environment first -- `growth-ixp-workshop` is the + old shape and is being retired -- and do not introduce new `staging` targets; + the one that exists predates this rule. - **Coded App names are derived, and must fit 32 characters.** A target that omits `codedApp.name` gets `-`, normalised to lowercase hyphens. The name is derived at config load rather than stored, so it cannot drift @@ -41,18 +48,22 @@ change the convention here and roll it out everywhere. by a date suffix truncate to the same name and would overwrite each other's app. Two targets may never resolve to the same name, which matters because `local` and a hosted target usually share a tenant -- give at least one of them an explicit - name. + name. Note that the derived shape, + `-`, predates the naming convention above and does not match + it, so every current target sets `codedApp.name` explicitly. - **Keep the product slug to 15 characters.** `uip codedapp deploy` rejects a name over 32 characters, and `baseUrl` must - always equal `//`, so the two move together. The standard - patterns spend most of the budget on fixed text: `workshop--local` costs - 15, `growth--workshop` 16, and `staging--workshop` 17. A 15-character - slug therefore fits every pattern; `case-management` is already at exactly 32 for - its staging form. Abbreviate in the slug rather than the prefix -- `comms-mining`, - not `communications-mining` -- because the prefix is what participants recognise - across workshops. `publish` happily accepts an over-long name and only `deploy` - refuses it, which leaves an orphan package behind, so `doctor` fails on this - first. + always equal `//`, so the two move together. `-workshop-` spends + 10 characters, leaving 22 to share between the slug and the target name. A + 15-character slug therefore leaves 7 for the target, which covers `local`, + `growth` and the retired `staging`; `case-management-workshop-staging` is exactly + 32. Abbreviate in the slug rather than the fixed part -- `comms-mining`, not + `communications-mining` -- because `-workshop` is what participants + recognise across workshops. A delivery target whose name carries a date or a city + overflows the limit and keeps a shortened explicit `codedApp.name` instead, which + is what the dated training targets do. `publish` happily accepts an over-long + name and only `deploy` refuses it, which leaves an orphan package behind, so + `doctor` fails on this first. - **Participant placeholders use angle brackets:** ``, and `` where initials specifically are wanted. Never `[participant name]`, `[your-name]`, or `{{your-name}}`. Angle brackets read as replace-me and diff --git a/src/commands/init.mjs b/src/commands/init.mjs index 30ae7f8..8bd8b55 100644 --- a/src/commands/init.mjs +++ b/src/commands/init.mjs @@ -21,8 +21,9 @@ import process from 'node:process'; const kitRoot = join(dirname(fileURLToPath(import.meta.url)), '..', '..'); -// `staging--workshop` is the tightest standard pattern at 17 characters of -// fixed text, against a 32-character Coded App name limit. +// Coded App names follow `-workshop-`: 10 characters of fixed text +// against a 32-character limit, leaving 22 to share between the slug and the target +// name. Reserving 7 for the target -- the longest in use -- caps the slug at 15. const PRODUCT_SLUG_LIMIT = 15; const templateDir = join(kitRoot, 'template'); @@ -67,16 +68,15 @@ export function init({product, title, root = process.cwd()} = {}) { } // Caught here rather than at deploy time. The slug ends up inside every target's // codedApp.name, and `uip codedapp deploy` refuses a name over 32 characters -- - // after `publish` has already accepted it and left a package behind. The tightest - // standard pattern is `staging--workshop`, which spends 17 on fixed text. + // after `publish` has already accepted it and left a package behind. The pattern + // is `-workshop-`, 10 characters of fixed text plus the target name. if (product.length > PRODUCT_SLUG_LIMIT) { console.error( `"${product}" is ${product.length} characters; keep the product slug to ${PRODUCT_SLUG_LIMIT}.\n` + ` Coded App names are capped at 32 and the slug goes inside all of them:\n` + - ` workshop-${product}-local ${`workshop-${product}-local`.length}\n` + - ` growth-${product}-workshop ${`growth-${product}-workshop`.length}\n` + - ` staging-${product}-workshop ${`staging-${product}-workshop`.length}\n` + - ` Abbreviate the slug, not the prefix: "comms-mining", not "communications-mining".`, + ` ${product}-workshop-local ${`${product}-workshop-local`.length}\n` + + ` ${product}-workshop-growth ${`${product}-workshop-growth`.length}\n` + + ` Abbreviate the slug, not the fixed part: "comms-mining", not "communications-mining".`, ); return 1; } diff --git a/template/config/workshop-targets.json b/template/config/workshop-targets.json index 3f597f3..947ef30 100644 --- a/template/config/workshop-targets.json +++ b/template/config/workshop-targets.json @@ -17,7 +17,7 @@ "orchestratorParentFolder": "Shared" }, "codedApp": { - "name": "workshop-__PRODUCT_SLUG__-local", + "name": "__PRODUCT_SLUG__-workshop-local", "description": "Local build of the __PRODUCT_TITLE__ Docusaurus site" } } From cc256dfeb55e4c5a20257d5641c5e8e5b7487c56 Mon Sep 17 00:00:00 2001 From: Tjeerd Stap <64895800+ThisIsTJ@users.noreply.github.com> Date: Fri, 28 Aug 2026 10:24:24 -0700 Subject: [PATCH 2/2] Release v1.7.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0b316e1..ae7aff5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@uipath-lab-tec/workshop-kit", - "version": "1.6.0", + "version": "1.7.0", "description": "Shared Docusaurus infrastructure for UiPath LAB TEC workshop repos.", "license": "UNLICENSED", "type": "module",