Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 23, 2025

This PR adds comprehensive documentation explaining how Moose versions are determined in Boreal cloud deployments for both Python and TypeScript projects.

Changes Made

  • New Boreal deployment documentation: Created /moose/deploying/boreal section with detailed version detection logic
  • TypeScript version detection: Documents the priority order (pnpm-lock.yaml → package-lock.json → package.json) with actual implementation code
  • Python version detection: Explains how Boreal searches setup.py and requirements.txt files, including subdirectory scanning
  • Navigation update: Added "Boreal Cloud" to the deployment section menu
  • Best practices: Included recommendations for both language ecosystems
  • Troubleshooting: Basic guidance for version mismatch issues

TypeScript Detection Logic

Shows how Boreal looks for @514labs/moose-lib version with fallback priority:

  1. pnpm-lock.yaml (preferred)
  2. package-lock.json
  3. package.json (fallback)

Python Detection Logic

Documents how Boreal searches for moose_lib version in:

  1. setup.py (preferred)
  2. requirements.txt (fallback)
  3. Including recursive subdirectory search

The documentation includes the actual implementation code from the issue description, making it clear to developers how version compatibility is automatically managed during Boreal deployments.

Fixes #2465.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copy link

vercel bot commented Jun 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
framework-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 23, 2025 5:05pm

Co-authored-by: jmsuzuki <2999398+jmsuzuki@users.noreply.github.com>
Copilot AI and others added 2 commits June 23, 2025 16:52
Co-authored-by: jmsuzuki <2999398+jmsuzuki@users.noreply.github.com>
Co-authored-by: jmsuzuki <2999398+jmsuzuki@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Update Framework Docs with how Moose Version are Determined in Boreal for Python and Typescript Add Boreal version detection documentation for Python and TypeScript Jun 23, 2025
@Copilot Copilot AI requested a review from jmsuzuki June 23, 2025 16:54
Copilot finished work on behalf of jmsuzuki June 23, 2025 16:54

return mooseVerRequirement;
}
```
Copy link
Contributor

Choose a reason for hiding this comment

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

do not provide code blocks. provide the logic.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed the JavaScript code blocks and replaced them with logical flow descriptions. The documentation now explains the version detection process without exposing implementation details. Commit af38659

…scriptions

Co-authored-by: jmsuzuki <2999398+jmsuzuki@users.noreply.github.com>
@Copilot Copilot AI requested a review from jmsuzuki June 23, 2025 17:05
Copilot finished work on behalf of jmsuzuki June 23, 2025 17:05
Copy link
Collaborator

@callicles callicles left a comment

Choose a reason for hiding this comment

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

Let's merge an iterate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Framework Docs with how Moose Version are Determined in Boreal for Python and Typescript

3 participants