Repository navigation
[Copilot Dreams] Check new resources in the right generated catalog 🤖🤖🤖 - #6161
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
| npm ci | ||
|
|
||
| # Build the project (generates README.md and marketplace.json) | ||
| # Build the project (generates category READMEs and marketplace.json) |
There was a problem hiding this comment.
🛠️ Find the generated catalogs: The old output description could send Copilot to the root README for resource listings, but the build writes those listings to category READMEs. The root README can still receive a separate featured-plugin update.
| 1. Create the file with proper front matter | ||
| 2. Add the file to the appropriate directory | ||
| 3. Update the README.md by running: `npm run build` | ||
| 3. Update `docs/README.agents.md` or `docs/README.instructions.md` by running: `npm run build` |
There was a problem hiding this comment.
🛠️ Check the resource's actual listing: Looking in the root README could make an added agent or instruction appear missing; the producer writes their listings to these two catalogs.
| 4. Add any bundled scripts or assets to the folder | ||
| 5. Make scripts executable: `chmod +x script.sh` | ||
| 6. Update the README.md by running: `npm run build` | ||
| 6. Update `docs/README.hooks.md` by running: `npm run build` |
There was a problem hiding this comment.
🛠️ Check the hook's actual listing: The root README is not the hook listing destination; the producer writes the hook catalog here, so the verification step now leads to the generated entry.
| 2. Include frontmatter with `name` and `description`, plus agentic workflow fields (`on`, `permissions`, `safe-outputs`) | ||
| 3. Compile with `gh aw compile --validate` to verify it's valid | ||
| 4. Update the README.md by running: `npm run build` | ||
| 4. Update `docs/README.workflows.md` by running: `npm run build` |
There was a problem hiding this comment.
🛠️ Check the workflow's actual listing: A root-README check could incorrectly suggest that a new workflow was omitted; the build writes the workflow listing to its category catalog.
| 3. Add any bundled assets (scripts, templates, data) to the skill folder | ||
| 4. Run `npm run skill:validate` to validate the skill structure | ||
| 5. Update the README.md by running: `npm run build` | ||
| 5. Update `docs/README.skills.md` by running: `npm run build` |
There was a problem hiding this comment.
🛠️ Check the skill's actual listing: Copilot could look for a generated skill entry in the wrong README; the producer writes skill entries to this category catalog.
| 3. Edit the generated `plugin.json` with your metadata | ||
| 4. Run `npm run plugin:validate` to validate the plugin structure | ||
| 5. Run `npm run build` to update README.md and marketplace.json | ||
| 5. Run `npm run build` to update `docs/README.plugins.md` and marketplace.json |
There was a problem hiding this comment.
🛠️ Check the plugin's actual listing: The old root-README destination could make a plugin listing appear absent, while the build writes the plugin catalog under docs. Marketplace generation remains part of the same command.
| 3. Ensure `assets/preview.png` exists as the primary visual asset | ||
| 4. Run `npm run plugin:validate` to validate plugin and extension metadata | ||
| 5. Run `npm run build` to regenerate website data and marketplace output | ||
| 5. Run `npm run build` to regenerate category READMEs and marketplace output |
There was a problem hiding this comment.
🛠️ Avoid assuming website data was refreshed: The old step could lead Copilot to believe this command also regenerates website data, but the package defines that as a separate script. This step now names the outputs its command actually regenerates.
| - Run `npm run build` to update the README | ||
| - **Always run `bash eng/fix-line-endings.sh`** to normalize line endings (CRLF → LF) | ||
| - Check that your new resource appears correctly in the README | ||
| - Check that your new resource appears correctly in `docs/README.<type>.md` |
There was a problem hiding this comment.
🛠️ Verify the listing where it is generated: Checking only the root README could incorrectly suggest that the build missed a resource; resource listings are written to category catalogs.
| > **Important:** All pull requests should target the **`main`** branch, not `staged`. | ||
|
|
||
| 1. **README updates**: New files should automatically be added to the README when you run `npm run build` | ||
| 1. **README updates**: New files should automatically be added to `docs/README.<type>.md` when you run `npm run build` |
There was a problem hiding this comment.
🛠️ Expect the correct generated diff: The old wording could prompt an unnecessary root-README edit for a new resource; the build updates the category listings instead. Conditional featured-plugin updates to the root README remain possible.
|
|
||
| - [ ] Run `npm install` (or `npm ci`) to install dependencies | ||
| - [ ] Run `npm run build` to generate the updated README.md | ||
| - [ ] Run `npm run build` to generate the updated `docs/README.<type>.md` |
There was a problem hiding this comment.
🛠️ Check the right build output before submitting: A successful build need not add a resource to the root README; its listing is generated in the corresponding category catalog, which is the output this checklist should verify.
github-actions
Bot
added
merge-risk:medium
ready-for-review
🚦 Submission status: 👀 Ready for reviewRisk tier: Why this tier
Automated checks
Review
Commands
Updated for |
🧠 How this helps Copilot
Copilot could look for a new resource in the repository's main README and mistakenly conclude that its listing is missing. The guidance now points to the category catalog where the build places that resource, and no longer suggests that this build refreshes website data.
Automated details
Source:
curate-memoriesDream, analyzingmainat858bca0.Discarded guidance: The plugin review checklist stays unchanged because review-rule learnings are outside this run's scope.