Repository navigation
docs: update development and release instructions - #84
Merged
Merged
Conversation
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation accurately reflects the referenced scripts, tests, hooks, and workflows.
Review effort: Balanced
Findings: None
What changed in this PR
Updates contributor and release documentation to match the repository’s current build, CI, versioning, and publishing workflows.
Changes:
- Clarifies development commands, CI environments, and bundle handling.
- Documents Conventional Commit titles and release-please versioning.
- Completes the automated release sequence, including bundle regeneration and npm publishing.
| File | Description |
|---|---|
README.md |
Documents the complete release workflow. |
CONTRIBUTING.md |
Corrects development, CI, PR, and versioning guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
4 of 10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix outdated development and release instructions in
CONTRIBUTING.md, and complete the "How a release happens" steps in the README.CONTRIBUTING.mdpackage.json:npm run buildistsconly, andnpm run bundlebuilds the bundle. The bundle may be built locally but must never be committed (a pre-commit hook blocks it).bundle-compatjob on Node 20.0.0.plugin.jsonfiles, the marketplace entry and the release-please manifest.Releaseworkflow regenerates and commitsplugin/scripts/bundle.json the release PR.main.@deploygate/mcpafter the tag and GitHub Release.Related Issue
Closes #83
Type of change
Test plan
npm run buildpassesnpm testpasses (235 tests)Every statement was checked against
package.json,.githooks/pre-commit,.github/workflows/ci.yml,.github/workflows/release.yml,.release-please-config.jsonandsrc/__tests__/plugin.test.ts.Checklist
plugin/.codex-plugin/plugin.jsonandplugin/.claude-plugin/plugin.jsonif applicable (not applicable: docs only)🤖 Generated with Claude Code