bump v1.0.1#982
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request systematically updates the project's internal version number and all external references to its associated Docker image to Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request bumps the project version from 1.0.0 to 1.0.1. The version number has been updated in the project's pyproject.toml, uv.lock, and various documentation and example files. The changes are consistent and correct for a version bump. However, I've noticed that the version number is hardcoded in multiple documentation and example files. To improve maintainability and reduce the risk of inconsistencies in future releases, I've suggested centralizing the version number, for instance by using placeholders and a substitution mechanism as part of your release process. This would make version bumps easier and less error-prone.
| | Docker | 27.5.1 | | ||
| | NVIDIA Container Toolkit | See [installation guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) | | ||
| | AReaL Image | `ghcr.io/inclusionai/areal-runtime:v1.0.0` (includes runtime dependencies and Ray components) | | ||
| | AReaL Image | `ghcr.io/inclusionai/areal-runtime:v1.0.1` (includes runtime dependencies and Ray components) | |
There was a problem hiding this comment.
To improve maintainability and reduce the chance of errors in future version bumps, consider using a variable for the version number. Since you are using Jupyter Book (as indicated by your project dependencies), you can define a substitution in your _config.yml file. For example:
myst_substitutions:
areal_version: 1.0.1Then, you can use {{ areal_version }} in your Markdown files. This would centralize the version number and ensure consistency across all documentation. For example, this line would become:
| AReaL Image | ghcr.io/inclusionai/areal-runtime:v{{ areal_version }} (includes runtime dependencies and Ray components) |
This change should be applied to all hardcoded versions in this file.
| memory: 32GB+ | ||
| disk_size: 256GB | ||
| image_id: docker:ghcr.io/inclusionai/areal-runtime:v1.0.0 | ||
| image_id: docker:ghcr.io/inclusionai/areal-runtime:v1.0.1 |
There was a problem hiding this comment.
Having the version number hardcoded in multiple example files makes version bumps tedious and error-prone. Consider using a placeholder for the version (e.g., AREAL_VERSION) and using a script to substitute it with the correct version from pyproject.toml as part of your release process. This would ensure all examples are always up-to-date with the release and simplifies future version bumps.
| resources: | ||
| accelerators: A100:8 | ||
| image_id: docker:ghcr.io/inclusionai/areal-runtime:v1.0.0 | ||
| image_id: docker:ghcr.io/inclusionai/areal-runtime:v1.0.1 |
There was a problem hiding this comment.
Hardcoding the version number in example YAML files like this one and single_node.sky.yaml can lead to maintenance issues. To avoid manual updates and potential inconsistencies, consider using a templating approach for these configuration files. A script could replace a version placeholder (e.g., {{ areal_version }}) with the actual version from pyproject.toml during your release process.
No description provided.