Update README.md and **/package.json files to prepare for open-source release#14
Conversation
Updates the package.json files for repo root, client & server in order to prepare for open-source release.
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
There was a problem hiding this comment.
Pull request overview
This pull request prepares the CodeQL Development MCP Server for open-source release by aligning all versioning with CodeQL CLI v2.23.9, updating project metadata, and significantly expanding documentation. The changes ensure consistency across the monorepo and improve clarity for potential contributors and users.
Changes:
- Aligned all package.json versions to 2.23.9 (matching CodeQL CLI v2.23.9 without "v" prefix)
- Updated Node.js engine requirement from >=24.10.0 to >=25.2.1 and npm from >=11.6.1 to >=11.6.2
- Expanded README.md with comprehensive sections on features, requirements, installation, supported languages, and project background
- Replaced LICENSE content with GitHub CodeQL Terms and Conditions
- Updated package metadata (names, keywords, author) for better clarity and open-source discoverability
Reviewed changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| server/package.json | Updated version to 2.23.9, changed name from _server suffix to base name, updated Node.js/npm engines, updated keywords and author, bumped esbuild to ^0.27.3 |
| package.json | Updated version to 2.23.9, changed name to add _repo suffix, reorganized and updated keywords, updated Node.js/npm engines |
| package-lock.json | Regenerated lockfile reflecting all package.json changes including versions, names, and dependency updates |
| client/package.json | Updated version to 2.23.9, updated keywords and author, updated Node.js/npm engines |
| README.md | Major expansion with new sections on features, limitations, project status, requirements, installation steps, supported languages, and acknowledgements |
| LICENSE | Added GitHub CodeQL Terms and Conditions (179 lines) |
| .github/skills/upgrade-codeql-cli-and-packs/SKILL.md | Updated documentation to clarify that all package.json files should match CLI version |
|
@data-douser I've opened a new pull request, #15, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@data-douser I've opened a new pull request, #16, to work on those changes. Once the pull request is ready, I'll request review from you. |
README.md and **/package.json file to prepare for open-source releaseREADME.md and **/package.json files to prepare for open-source release
Summary of Changes
This pull request introduces several important updates to versioning, documentation, and metadata for the CodeQL Development MCP Server project. The main focus is aligning all version-bearing files to the CodeQL CLI version, improving documentation for clarity and completeness, and updating project metadata for consistency and accuracy.
Outline of Changes
Documentation and Onboarding Improvements:
README.mdto clarify project purpose, features, requirements, installation steps, supported languages, contribution guidelines, and support channels. Now includes sections on project status, background, roadmap, and acknowledgements. [1] [2].github/skills/upgrade-codeql-cli-and-packs/SKILL.mdto clarify the version alignment strategy, now specifying that allpackage.jsonfiles should match the CLI version (without the "v" prefix), and providing explicit update instructions. [1] [2]Version Alignment and Package Metadata Updates:
versionfield in allpackage.jsonfiles (package.json,client/package.json,server/package.json) to2.23.9to align with the target CodeQL CLI version, and updated thename,author, andkeywordsfields for consistency and improved discoverability. [1] [2] [3] [4] [5] [6]client/package.jsonandserver/package.jsonto require Node.js v25.2.1+ and npm v11.6.2+. [1] [2]Development Workflow Improvements:
esbuilddev dependency version inserver/package.jsonand reordering of theformatnpm script for consistency. [1] [2]