Related Issues/PRs

What changes are proposed in this pull request?

This PR updates the getChangedDocPages function in .github/workflows/preview-comment.js to alphabetically sort the returned documentation pages by path. This makes it easier for users to look up specific changed documentation pages in PR comments, especially when there are many changes.

Changes:

• Added .sort((a, b) => a.page.localeCompare(b.page)) to sort pages alphabetically after collecting them
• Updated JSDoc comment to document that the returned array is sorted alphabetically by page path

Example output (before - unsorted):

- tracking (modified)
- api/python (added)
- deployment/kubernetes (modified)
- api (modified)

Example output (after - sorted):

- api (modified)
- api/python (added)
- deployment/kubernetes (modified)
- tracking (modified)

How is this PR tested?

• Existing unit/integration tests
• New unit/integration tests
• Manual tests

Manual testing:
Created comprehensive test scripts that verify:

• Basic alphabetical sorting works correctly
• Nested paths are sorted properly (e.g., api comes before api/python)
• Path transformations still work correctly (classic-ml → ml)
• Non-documentation files are filtered out correctly
• All test cases pass successfully

Does this PR require documentation update?

• No. You can skip the rest of this section.
• Yes. I've updated:
  • Examples
  • API references
  • Instructions

Release Notes

Is this a user-facing change?

• No. You can skip the rest of this section.
• Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

• area/tracking: Tracking Service, tracking client APIs, autologging
• area/models: MLmodel format, model serialization/deserialization, flavors
• area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
• area/scoring: MLflow Model server, model deployment tools, Spark UDFs
• area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
• area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
• area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
• area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
• area/projects: MLproject format, project running backends
• area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
• area/build: Build and test infrastructure for MLflow
• area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

• rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
• rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
• rn/feature - A new user-facing feature worth mentioning in the release notes
• rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
• rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

• Yes (this PR will be cherry-picked and included in the next patch release)
• No (this PR will be included in the next minor release)

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