Skip to content

Update README.md and **/package.json files to prepare for open-source release#14

Merged
data-douser merged 5 commits intomainfrom
dd/open-source-release-prep/1
Feb 6, 2026
Merged

Update README.md and **/package.json files to prepare for open-source release#14
data-douser merged 5 commits intomainfrom
dd/open-source-release-prep/1

Conversation

@data-douser
Copy link
Copy Markdown
Collaborator

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:

  • Major rewrite and expansion of README.md to 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]
  • Added a new section in .github/skills/upgrade-codeql-cli-and-packs/SKILL.md to clarify the version alignment strategy, now specifying that all package.json files should match the CLI version (without the "v" prefix), and providing explicit update instructions. [1] [2]

Version Alignment and Package Metadata Updates:

  • Updated the version field in all package.json files (package.json, client/package.json, server/package.json) to 2.23.9 to align with the target CodeQL CLI version, and updated the name, author, and keywords fields for consistency and improved discoverability. [1] [2] [3] [4] [5] [6]
  • Updated Node.js and npm engine requirements in client/package.json and server/package.json to require Node.js v25.2.1+ and npm v11.6.2+. [1] [2]

Development Workflow Improvements:

  • Minor update to the esbuild dev dependency version in server/package.json and reordering of the format npm script for consistency. [1] [2]

Updates the package.json files for repo root, client & server in order
to prepare for open-source release.
@data-douser data-douser self-assigned this Feb 6, 2026
@data-douser data-douser added the documentation Improvements or additions to documentation label Feb 6, 2026
@data-douser data-douser requested a review from enyil as a code owner February 6, 2026 01:27
@data-douser data-douser added the enhancement New feature or request label Feb 6, 2026
@data-douser data-douser requested a review from a team as a code owner February 6, 2026 01:27
@data-douser data-douser added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Feb 6, 2026
Copilot AI review requested due to automatic review settings February 6, 2026 01:27
@github-advanced-security
Copy link
Copy Markdown

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread server/package.json
Comment thread client/package.json
Comment thread README.md Outdated
Comment thread server/package.json Outdated
Comment thread client/package.json Outdated
Comment thread package.json Outdated
Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 6, 2026

@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.

Copilot AI and others added 2 commits February 5, 2026 20:37
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 6, 2026 03:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 7 changed files in this pull request and generated 1 comment.

Comment thread README.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 6, 2026

@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.

@data-douser data-douser changed the title Update README.md and **/package.json file to prepare for open-source release Update README.md and **/package.json files to prepare for open-source release Feb 6, 2026
@data-douser data-douser added this pull request to the merge queue Feb 6, 2026
Merged via the queue into main with commit 2bb3df6 Feb 6, 2026
13 checks passed
@data-douser data-douser deleted the dd/open-source-release-prep/1 branch February 6, 2026 04:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request javascript Pull requests that update javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants