-
Notifications
You must be signed in to change notification settings - Fork 55
Add noop tool call to changeset generator for skipped PRs #13393
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -61,21 +61,48 @@ Your task is to: | |||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 1. **Analyze the Pull Request**: Review the pull request title and description above to understand what has been modified. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 2. **Use the repository name as the package identifier** (gh-aw) | ||||||||||||||||||||||||||
| 2. **Determine if a Changeset is Needed**: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **If the PR does NOT require a changeset** (see criteria below), call the `noop` tool with a reason message and **stop immediately**: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ```javascript | ||||||||||||||||||||||||||
| noop({ | ||||||||||||||||||||||||||
| message: "No changeset needed: <reason>" | ||||||||||||||||||||||||||
| }) | ||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **PRs that do NOT require a changeset**: | ||||||||||||||||||||||||||
| - Documentation-only changes (README, docs/, comments) | ||||||||||||||||||||||||||
| - Test-only changes (test files, fixtures) | ||||||||||||||||||||||||||
| - CI/CD configuration changes (.github/workflows/, .github/actions/) | ||||||||||||||||||||||||||
| - Development tooling changes (Makefile, scripts/, build configs) | ||||||||||||||||||||||||||
| - Changes to repository metadata (.gitignore, LICENSE, etc.) | ||||||||||||||||||||||||||
| - Internal refactoring with no user-facing impact | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **PRs that DO require a changeset**: | ||||||||||||||||||||||||||
| - Bug fixes affecting users | ||||||||||||||||||||||||||
| - New features or capabilities | ||||||||||||||||||||||||||
| - Breaking changes in APIs or CLI | ||||||||||||||||||||||||||
| - Performance improvements | ||||||||||||||||||||||||||
| - Dependency updates that affect functionality | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| If a changeset is needed, proceed with the steps below. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 3. **Use the repository name as the package identifier** (gh-aw) | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 3. **Determine the Change Type**: | ||||||||||||||||||||||||||
| 4. **Determine the Change Type**: | ||||||||||||||||||||||||||
| - **major**: Major breaking changes (X.0.0) - Very unlikely, probably should be **minor** | ||||||||||||||||||||||||||
| - **minor**: Breaking changes in the CLI (0.X.0) - indicated by "BREAKING CHANGE" or major API changes | ||||||||||||||||||||||||||
| - **patch**: Bug fixes, docs, refactoring, internal changes, tooling, new shared workflows (0.0.X) | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **Important**: Internal changes, tooling, and documentation are always "patch" level. | ||||||||||||||||||||||||||
|
Comment on lines
+93
to
98
|
||||||||||||||||||||||||||
| 4. **Determine the Change Type**: | |
| - **major**: Major breaking changes (X.0.0) - Very unlikely, probably should be **minor** | |
| - **minor**: Breaking changes in the CLI (0.X.0) - indicated by "BREAKING CHANGE" or major API changes | |
| - **patch**: Bug fixes, docs, refactoring, internal changes, tooling, new shared workflows (0.0.X) | |
| **Important**: Internal changes, tooling, and documentation are always "patch" level. | |
| 4. **Determine the Change Type (if a changeset is needed)**: | |
| - **major**: Major breaking changes (X.0.0) - Very unlikely, probably should be **minor** | |
| - **minor**: Breaking changes in the CLI (0.X.0) - indicated by "BREAKING CHANGE" or major API changes | |
| - **patch**: Bug fixes, performance improvements, dependency updates that affect functionality, new shared workflows (0.0.X) | |
| **Important**: When a changeset is required for internal-only, tooling, or documentation-related work (for example, when mixed with user-facing changes), it should always be recorded as "patch" level. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instructions say to call
noop(...)and "stop immediately" when skipping, but they don’t explicitly say not to append a "Changeset" section to the PR description in that path. To avoid accidental PR-body updates when no changeset was created, consider adding a sentence that the workflow must not callupdate_pull_requestwhen exiting vianoop.