Skip to content

Commit afcbeed

Browse files
Add a skills for adding changelog entries and updating package versions (#9781)
* Add a skill for adding changelog entries to DevTools packages * Add skill for updating package versions that is used from the changelog skill * add exception for copyright requirement * address comments * Update .agents/skills/adding-changelog-entries/SKILL.md Co-authored-by: Jacob MacDonald <jakemac@google.com> * Update .agents/skills/adding-changelog-entries/SKILL.md Co-authored-by: Jacob MacDonald <jakemac@google.com> * whitespace --------- Co-authored-by: Jacob MacDonald <jakemac@google.com>
1 parent da50b29 commit afcbeed

3 files changed

Lines changed: 37 additions & 1 deletion

File tree

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: adding-changelog-entries
3+
description: Use when documenting changes in CHANGELOG.md files for devtools_shared, devtools_app_shared, or devtools_extensions.
4+
---
5+
6+
# Adding Changelog Entries
7+
8+
When adding changelog entries to published packages (`devtools_shared`, `devtools_app_shared`, and `devtools_extensions`), follow these rules:
9+
10+
- **Check Publication State**: Never add an entry to an already published version (e.g. `# 12.1.0`). You MUST check which versions are published on pub.dev (e.g., at `https://pub.dev/packages/<package_name>/versions`) before determining section headers! If a version is not yet published, it should be suffixed with the next numeric `-wip` tag (e.g., `## 0.5.1-wip`) or follow the existing convention in the file, such as `(not released)`. You should also match the existing header level (H1 or H2) used for versions in that file. Avoid generic placeholder headers like `# WIP`!
11+
- **New Version Headers**: If a version bump is required, you MUST first use the instructions in [updating-package-versions](../updating-package-versions/SKILL.md) to update the package version in `pubspec.yaml`, and then add a new header to the changelog file with the new version (e.g., `## 0.5.1-wip`) before adding your entries.
12+
- **Accurately Distinguish Packages**: Ensure that the cleanups or edits applied to a specific package's changelog entries belong strictly to that package path (e.g., changes in `devtools_app` do not warrant entries in `devtools_shared`).
13+
- **Conciseness and Accuracy**: Describe clearly what was changed and why. Avoid generic descriptions without context, such as "Fixes missing deprecation message". Indicate specifically what was added or removed.
14+
- **User visible changes ONLY**: Only add entries in the changelog if the change is meaningful to consumers of the package. Do not include internal refactoring notes or other trivial changes that users do not care about.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: updating-package-versions
3+
description: Guides updating dependency versions in published packages to avoid mono-repo resolution failures.
4+
---
5+
6+
# Updating Package Versions
7+
8+
When updating dependency versions in published package `pubspec.yaml` files (`devtools_shared`, `devtools_app_shared`, and `devtools_extensions`), follow these rules to protect the local mono-repo workspace graph:
9+
10+
- **Version Decisions**: Decide if it should be a major, minor, or patch version based on your edits:
11+
- **Breaking changes**: Major bump (+1 to first component, others reset to 0). E.g., removals of public constants, properties, getters/setters, or APIs.
12+
- **New features or deprecation start**: Minor bump (+1 to second component, patch resets to 0).
13+
- **Bug fixes and non-breaking changes**: Patch bump (+1 to third component).
14+
- **Match Exact Versions**: Always use the **actual** version specified in the target package's `pubspec.yaml` file.
15+
- **Suffix Preservation**: If a requested version contains a suffix like `-wip` (e.g., `13.0.0-wip`), the full string MUST be used in dependency constraints (e.g., `devtools_shared: ^13.0.0-wip`).
16+
- **Prevent Graph Failures**: Do not drop the suffix or estimate the base version tags. Version solver operations will fail in the local workspace if dependencies point to published strings that can't be resolved in non-published repositories.
17+
- **No Dependencies on Unpublished Packages**: Published packages (`devtools_shared`, `devtools_app_shared`, and `devtools_extensions`) MUST NOT depend on unpublished packages like `devtools_app` or `devtools_test`.
18+
- **Resolution Testing**: After updating versions, run `flutter pub get` in the repository to ensure version solving is satisfied. If this returns errors, you should fix the errors and try again.
19+
- **Updating devtools_app**: In `packages/devtools_app/pubspec.yaml`:
20+
- Dependencies on published packages do not have version constraints. This is intentional; do not change this when updating versions.
21+
- Always use the `dt update-version` tool to update the `devtools_app` version.
22+
- This should only be updated for monthly releases and cherry pick releases, so perform this update only when explicitly asked to.

.gemini/styleguide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and the CI testing ensures that the code is formatted correctly.
1414
- `[NIT]`: Idiomatic improvements or minor naming suggestions.
1515
- **Focus:** Prioritize logic, performance on the UI thread, and architectural consistency.
1616
- **No Empty Praise:** Do not leave "Looks good" or "Nice change" comments. If there are no issues, leave no comments.
17-
- **Copyright Headers:** Ensure all new files have a proper copyright header with the current year. For example:
17+
- **Copyright Headers:** Ensure all new files (except for agent skills and generated files) have a proper copyright header with the current year. For example:
1818
```
1919
// Copyright 2026 The Flutter Authors
2020
// Use of this source code is governed by a BSD-style license that can be

0 commit comments

Comments
 (0)