merge

Author: mfranzke

.changeset/README.md

@@ -0,0 +1,146 @@
+# 🚢 Release Workflow with Changesets
+
+This document describes how we use [Changesets](https://github.com/changesets/changesets) in our daily development workflow to manage versions, changelogs, and releases in this monorepo.
+
+---
+
+## 📖 What are Changesets?
+
+A **changeset** is a small Markdown file committed alongside your code changes. It records:
+
+- Which packages are affected
+- What type of version bump they require (`patch`, `minor`, `major`)
+- A short description that will appear in the changelog
+
+By collecting these small pieces of information, we can automatically generate:
+
+- Version bumps in `package.json`
+- Updated `CHANGELOG.md` entries
+- Release PRs and npm publishes
+- [GitHub Releases](https://github.com/db-ux-design-system/core-web/releases)
+
+---
+
+## 🛠 Workflow
+
+### 1. After making a change → add a changeset
+
+Run:
+
+```bash
+npx changeset
+```
+
+You’ll be prompted to:
+
+- Select affected packages
+- Choose the bump/release type (patch, minor, major)
+- Provide a short summary for the changelog
+
+This creates a file like `.changeset/abcd123.md`.
+👉 Commit this file as part of your PR.
+
+### 2. Open a Pull Request
+
+- Every PR that changes published code must include a changeset file.
+- CI will verify the existence of at least one changeset when necessary.
+
+### 3. Release PRs
+
+When PRs are merged into `main` branch, the Release workflow will:
+
+- Collect pending changesets
+- Open (or update) a Release PR called “Version Packages”
+- Run `changeset version` to bump versions and update changelogs
+
+This PR should be reviewed like any other:
+
+- Check the versions are correct
+- Review the generated changelogs
+
+Once everything looks good, merge the Release PR.
+
+### 4. Publishing
+
+After the Release PR is merged into `main` branch:
+
+- CI will build the packages (`./build-outputs/`)
+- Publish new versions to npm with the tag `latest`
+- Create a [GitHub Release](https://github.com/db-ux-design-system/core-web/releases)
+
+You don’t have to run anything manually, it’s handled by CI.
+
+---
+
+## ✅ Best Practices
+
+- **Always add a changeset**
+
+    If your code change affects published packages, create a changeset.
+
+    No changeset → no version bump → no release.
+
+- **Choose the correct bump type**
+    - patch: bugfix, no API or HTML changes
+    - minor: new features, changes in inner component markup or behavior, backwards-compatible
+    - major: breaking changes (e.g. removed props, changed APIs)
+
+- **Write user-friendly summaries**
+
+    The text you provide will be copied into the `CHANGELOG.md`. Keep it concise and helpful.
+
+- **One changeset per PR**
+
+    Usually you only need one. If a PR touches multiple packages with different bump types, a single changeset can cover them all.
+
+- **Baseline snapshots**
+
+    ARIA snapshots by Playwright help detect markup changes. If they change, prefer minor instead of patch.
+    And please mention those HTML changes within the `CHANGELOG.md` or of necessary (like bigger changes) in a [migration guide](https://github.com/db-ux-design-system/core-web/tree/main/docs/migration).
+
+- **Avoid manual version bumps**
+
+    Never edit `package.json` `version` field by hand. Changesets handles this automatically.
+
+---
+
+## 🚧 Pre-Releases
+
+We handle pre-releases without changesets.
+Instead, create a new [GitHub release](https://github.com/db-ux-design-system/core-web/releases/new)
+with a tag like `1.2.3-next0` and the CI will pick it up and publish it to npm with the tag `next`.
+
+
+---
+
+
+## 🔑 Cheatsheet
+
+```bash
+# Initialize Changesets (only once per repo)
+npx changeset init
+
+# Create a new changeset
+npx changeset
+
+# Show pending releases
+npx changeset status --verbose
+
+# Apply version bumps and changelogs
+npx changeset version
+
+# Pre-release mode
+npx changeset pre enter next # enter prerelease
+npx changeset pre exit # exit prerelease
+```
+
+---
+
+## 📂 File Overview
+
+- `.changeset/` → contains pending changesets (`.md` files)
+- `package.json` → versions are updated automatically in this file
+- `CHANGELOG.md` → updated by changeset version
+- `.github/workflows/changesets-release-pr.yml` → automation for Release PRs & publishing
+- `.github/workflows/pull-request-snapshot-diff.yml` → validates changes in PNG/YML snapshots and enforces at least a MINOR bump
+- `scripts/github/publish-npm.js` → custom publish script (packs & publishes built outputs)

.changeset/cold-chairs-tease.md

@@ -0,0 +1,8 @@
+---
+"@db-ux/core-foundations": patch
+"@db-ux/core-components": patch
+"@db-ux/agent-cli": patch
+---
+
+chore: update instructions files for better copilot outputs
+fix: add some missing variables

.changeset/config.json

@@ -0,0 +1,38 @@
+{
+	"$schema": "https://unpkg.com/@changesets/config/schema.json",
+	"changelog": [
+		"scripts/github/changesets/create-changelog.js",
+		{ "owner": "db-ux-design-system", "repo": "core-web" }
+	],
+	"commit": false,
+	"fixed": [
+		[
+			"@db-ux/core-foundations",
+			"@db-ux/core-components",
+			"@db-ux/react-core-components",
+			"@db-ux/ngx-core-components",
+			"@db-ux/v-core-components",
+			"@db-ux/wc-core-components",
+			"@db-ux/core-stylelint",
+			"@db-ux/core-migration",
+			"@db-ux/agent-cli"
+		]
+	],
+	"ignore": [
+		"scripts",
+		"@db-ux/docs",
+		"@db-ux/e2e",
+		"angular-showcase",
+		"angular-ssr-showcase",
+		"next-showcase",
+		"nuxt-showcase",
+		"patternhub",
+		"react-showcase",
+		"stencil-showcase",
+		"vue-showcase"
+	],
+	"linked": [],
+	"access": "public",
+	"baseBranch": "origin/main",
+	"updateInternalDependencies": "patch"
+}

.config/.jscpd.json

@@ -12,6 +12,7 @@
 		"**/.next/**",
 		"**/.nuxt/**",
 		"**/.output/**",
+		"**/agent/**",
 		"**/.vscode/**",
 		"**/*-example/index.html",
 		"**/*-showcase/index.html",
@@ -46,6 +47,8 @@
 		"packages/foundations/assets/icons/functional/fonts/**",
 		"packages/foundations/assets/icons/fonts/**",
 		"packages/foundations/dev",
+		"packages/migration/test/**/has-changes.txt",
+		"packages/migration/test/**/no-change.txt",
 		"showcases/**/results/**",
 		"showcases/angular-showcase/.angular/cache",
 		"showcases/angular-showcase/.angular/cache/**",
@@ -61,5 +64,6 @@
 		"showcases/shared/*.json",
 		"showcases/vue-showcase/src/components/form/Form.vue"
 	],
+	"ignorePattern": ["<option value=\"test5\">Test5</option>"],
 	"absolute": true
 }

.config/.lintstagedrc.js

@@ -8,5 +8,12 @@ export default {
 	'stylelint.config.*': 'stylelint --validate --allow-empty-input',
 	// And elsewhere we don't, compare to https://github.com/stylelint/stylelint/pull/8009
 	'*.{css,scss}': 'stylelint --fix --allow-empty-input --no-validate',
-	'*.{js,ts,tsx,jsx,mjs,cjs}': 'xo --fix'
+	'*.{js,ts,tsx,jsx,mjs,cjs}': 'xo --fix',
+	// ensure that security vulnerabilities are fixed before committing - we need to skip `dev` for the moment as there are some unsolveable conflicts
+	'package-lock.json': 'npm audit fix --omit=dev',
+	// ensure that lock file is up to date
+	'**/package.json': [
+		() => 'npm install --package-lock-only --ignore-scripts',
+		'npx npm-package-json-lint'
+	],
 };

.config/.markdown-lint.yml

@@ -32,7 +32,7 @@ MD026:
 MD029: false # Ordered list item prefix
 MD030: false
 MD033:
-  allowed_elements: [br]
+  allowed_elements: [br, details, summary]
 MD036: false # Emphasis used instead of a heading
 MD041: false # h1 first line is not working in this monorepo
 MD049: false # emphasis-style Emphasis style should be consistent

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -9,7 +9,13 @@ body:
       value: |
         Thank you for taking the time to fill out this bug report! Feedback from the community is highly valuable to us, as it helps improve our work and benefits all users. 🙂
 
-        We would be more than happy if you could share a URL if the problem occurs in our [documentation](https://design-system.deutschebahn.com/core-web/), or at least some code. Even better would be a [working example on StackBlitz or CodeSandbox](https://design-system.deutschebahn.com/core-web/version/latest/foundations/playgrounds). Please keep in mind not to share any internal information or data this way. This includes internal URLs. Only use sample material.
+        We would be more than happy if you could share a URL if the problem occurs in our [documentation](https://design-system.deutschebahn.com/core-web/), or at least some code. Even better would be a [working example on StackBlitz or CodeSandbox](https://design-system.deutschebahn.com/core-web/version/latest/foundations/playgrounds).
+
+        ⚠️ **Please keep in mind to use anonymous sample material:**
+        - **Do not share any personal data (e.g., names, email addresses, customer data)**
+        - **Do not attach any confidential company information**
+        - **Do not upload full-screen product screenshots**
+        - **Do not share internal URLs.**
 
   - type: checkboxes
     id: component

.github/ISSUE_TEMPLATE/github_copilot_instructions.yaml

@@ -0,0 +1,127 @@
+name: 📄 GitHub Copilot Instructions feedback
+description: Share feedback about the .github/copilot-instructions.md documentation (model choice, prompt results, clarity, etc.).
+title: "[GitHub Copilot Instructions feedback]: "
+labels: [📕documentation, 💡copilot]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to share your feedback! This form is to help us improve the `.github/copilot-instructions.md` documentation provided in the design system by using the [`@db-ux/agent-cli`](https://www.npmjs.com/package/@db-ux/agent-cli) node package.
+
+        ⚠️ **Please keep in mind to use anonymous sample material:**
+        - **Do not share any personal data (e.g., names, email addresses, customer data)**
+        - **Do not attach any confidential company information**
+        - **Do not upload full-screen product screenshots**
+        - **Do not share internal URLs.**
+
+  - type: input
+    id: model-used
+    attributes:
+      label: 🤖 Model you used
+      description: Which model (if any) did you follow or reference from the documentation?
+      placeholder: e.g. GPT-4o, Claude 2, Custom LLM, etc.
+    validations:
+      required: false
+
+  - type: textarea
+    id: prompt-used
+    attributes:
+      label: 💬 Prompt or usage example
+      description: Share the exact or approximate prompt or example you tried using, based on the documentation.
+      placeholder: Copy/paste or summarize the input/prompt you used.
+    validations:
+      required: false
+
+  - type: textarea
+    id: issue-description
+    attributes:
+      label: ❗ What didn’t work as expected?
+      description: Describe what was confusing, broken, or didn’t meet your expectations. Be as detailed as possible.
+      placeholder: Include any error messages, mismatches, unexpected behaviors, or missing context.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: ✅ What did you expect instead?
+      description: What outcome were you hoping for or expecting based on the instructions provided?
+      placeholder: Describe the result you thought you’d get.
+    validations:
+      required: false
+
+  - type: textarea
+    id: suggestions
+    attributes:
+      label: 💡 Suggestions for improvement
+      description: How could we make the documentation clearer, more accurate, or more helpful?
+      placeholder: e.g. "Add a note about prompt structure", "Link to working examples", etc.
+    validations:
+      required: false
+
+  - type: dropdown
+    id: ide
+    attributes:
+      label: 📝 Which IDE did you use?
+      description: Please provide information on the IDE you've used.
+      options:
+        - Visual Studio Code
+        - IntelliJ
+        - Others (please provide more information in another field)
+    validations:
+      required: false
+
+  - type: dropdown
+    id: clarity-rating
+    attributes:
+      label: 📝 How clear was the documentation?
+      description: Rate how easy it was to follow the instructions.
+      options:
+        - 1 - Very unclear
+        - 2 - Somewhat unclear
+        - 3 - Neutral
+        - 4 - Mostly clear
+        - 5 - Very clear
+    validations:
+      required: false
+
+  - type: input
+    id: link-or-context
+    attributes:
+      label: 🔗 Context (optional)
+      description: If you're referencing a specific section or line in the documentation, include a link or brief context.
+      placeholder: e.g. Line 32 in .github/copilot-instructions.md or a permalink to the file
+    validations:
+      required: false
+
+  - type: dropdown
+    id: businessunit
+    attributes:
+      label: Which DB business unit do you work for?
+      options:
+        - DB Systel GmbH (please name your customer below)
+        - DB Fernverkehr AG
+        - DB Regio AG
+        - DB InfraGO AG
+        - DB Cargo AG
+        - DB Konzern
+        - DB Vertrieb GmbH
+        - DB Energie
+        - DB Connect
+        - other (please specify below)
+    validations:
+      required: false
+
+  - type: input
+    id: businessunit2
+    attributes:
+      label: ”DB Systel” please enter your customer / ”other” please enter your area or business unit.
+    validations:
+      required: false
+
+  - type: input
+    id: project
+    attributes:
+      label: What project are you working on?
+    validations:
+      required: false