feat: add first 5 rules to group name (used e.g. when naming cluster/cloud jobs or logfiles)#3168
Conversation
…cloud jobs or logfiles)
WalkthroughThe changes involve an update to the Changes
Sequence Diagram(s)sequenceDiagram
participant GroupJob
participant RuleManager
GroupJob->>RuleManager: Request associated rule names
RuleManager-->>GroupJob: Return list of rule names
GroupJob->>GroupJob: Construct name string
GroupJob->>GroupJob: Truncate if more than five rules
GroupJob-->>Client: Return formatted name
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
snakemake/jobs.py (1)
1531-1534: LGTM! The implementation enhances group job name readability.The changes improve the clarity of group job names by including up to 5 rule names, making it easier to identify the contents of group jobs in logs and monitoring tools.
Consider handling these edge cases in future improvements:
- Rule names containing underscores could make the group job name harder to parse
- Empty rule sets (though this should never happen in practice)
- Rule name sanitization (if not already handled elsewhere)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- snakemake/jobs.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
snakemake/jobs.py (1)
Pattern
**/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of theselfargument of methods.
Do not suggest type annotation of theclsargument of classmethods.
Do not suggest return type annotation if a function or method does not contain areturnstatement.
🤖 I have created a release *beep* *boop* --- ## [8.25.0](v8.24.1...v8.25.0) (2024-10-29) ### Features * add first 5 rules to group name (used e.g. when naming cluster/cloud jobs or logfiles) ([#3168](#3168)) ([5657122](5657122)) * allow to mark input files of rules as ancient via the API or command line interface (and thereby also via workflow specific profiles). Putting this into a workflow specific profile (or specifying as argument) allows to overrule rerun triggers caused by file modification dates where the user knows better. ([#3171](#3171)) ([6f3aed3](6f3aed3)) ### Bug Fixes * skip storage object when cloning flags for shadowed IO ([#3174](#3174)) ([d733fed](d733fed)) * use permission safe copying when hidden conda files are already present in a workdir. This avoids problems in case multiple people use the same workdir and workflow. ([#3169](#3169)) ([c98b2e7](c98b2e7)) ### Documentation * add tutorial references and small syntax fix ([#3172](#3172)) ([6bee12a](6bee12a)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
fixes snakemake/snakemake-executor-plugin-slurm#154
QC
docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).Summary by CodeRabbit
New Features
Bug Fixes