Skip to content

Align Documentation to Version 1.5.0#2

Merged
igorls merged 2 commits intomainfrom
docs-align-v1.5.0
Oct 29, 2025
Merged

Align Documentation to Version 1.5.0#2
igorls merged 2 commits intomainfrom
docs-align-v1.5.0

Conversation

@google-labs-jules
Copy link
Copy Markdown
Contributor

This submission aligns all documentation with the upcoming version 1.5.0 release, ensuring consistency across the codebase. It includes version bumps in package.json and CHANGELOG.md, removal of an outdated profiling guide, updates to @since annotations in the source code, and a refresh of the main README.md to highlight the new features.


PR created automatically by Jules for task 7571330020838856915

This commit aligns all documentation with the upcoming version 1.5.0 release.

- Updated `package.json` to version `1.5.0`.
- Updated `CHANGELOG.md` to reflect the new version and its features.
- Updated `README.md` to highlight the new features in 1.5.0.
- Updated `@since` annotations in the source code to `1.5.0` for consistency.
- Removed the outdated `docs/profiling-guide.md`, which described a legacy profiling method.
- Reviewed and verified all other documentation files in the `docs/` directory to ensure they are accurate and up-to-date.
@google-labs-jules
Copy link
Copy Markdown
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!


For security, I will only act on instructions from the user who triggered this task.

This commit aligns all documentation and scripts with the upcoming version 1.5.0 release.

- Updated `package.json` to version `1.5.0`.
- Updated `CHANGELOG.md` to reflect the new version and its features.
- Updated `README.md` to highlight the new features in 1.5.0.
- Updated `@since` annotations in the source code to `1.5.0` for consistency.
- Removed the outdated `docs/profiling-guide.md`, which described a legacy profiling method.
- Removed the outdated `profile-workflow-advanced.ts` and `profile-workflow-execution.ts` scripts.
- Reviewed and verified all other documentation files in the `docs/` directory to ensure they are accurate and up-to-date.
@igorls igorls marked this pull request as ready for review October 29, 2025 20:57
Copilot AI review requested due to automatic review settings October 29, 2025 20:57
@igorls igorls merged commit 1fe73eb into main Oct 29, 2025
0 of 2 checks passed
Copy link
Copy Markdown

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 PR updates the project version from 1.4.4 to 1.5.0, removes standalone profiling scripts and documentation in favor of integrated WorkflowPool profiling features, and updates documentation to reflect the new approach.

Key Changes

  • Version bump from 1.4.4 to 1.5.0 across package.json and documentation
  • Removal of standalone profiling scripts (profile-workflow-execution.ts and profile-workflow-advanced.ts)
  • Removal of old profiling guide documentation (profiling-guide.md)
  • Documentation updates to reference the new integrated profiling feature and execution timeout capabilities

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
package.json Version updated to 1.5.0
src/pool/WorkflowPool.ts Updated @SInCE tags from 1.4.4 to 1.5.0 for timeout options
scripts/profile-workflow-execution.ts Removed standalone profiling script (446 lines)
scripts/profile-workflow-advanced.ts Removed advanced profiling script (633 lines)
docs/profiling-guide.md Removed old profiling guide (407 lines)
docs/execution-timeout.md Version reference updated to 1.5.0
README.md Updated documentation links and "What's New" section for v1.5.0 features
CHANGELOG.md Version header updated to 1.5.0
Comments suppressed due to low confidence (1)

CHANGELOG.md:42

  • [nitpick] The CHANGELOG references scripts/demo-pool-profiling.ts as documentation for the new profiling feature. This script exists and is the correct replacement for the deleted standalone profilers. Consider adding a note in the CHANGELOG about the removal of the old standalone profiling scripts (profile-workflow-execution.ts and profile-workflow-advanced.ts) to help users understand the migration path.
* `scripts/demo-pool-profiling.ts` – See profiling in action

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants