docs: task.previousTrace directive Documentation#6538
Merged
bentsherman merged 12 commits intonextflow-io:masterfrom Nov 12, 2025
Merged
docs: task.previousTrace directive Documentation#6538bentsherman merged 12 commits intonextflow-io:masterfrom
bentsherman merged 12 commits intonextflow-io:masterfrom
Conversation
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Rashmi Naidu <rnaidugit@gmail.com>
Signed-off-by: Rashmi Naidu <rnaidugit@gmail.com>
Signed-off-by: Rashmi Naidu <rnaidugit@gmail.com>
66be72b to
6051746
Compare
|
Created PR from personal account to add clarification to docs for task.previousTrace directive and accessible metadata fields |
- Clean up Signed-off-by: Chris Hakkaart <chris.hakkaart@seqera.io>
- Fix admonition block end - Apply language consistency Signed-off-by: Chris Hakkaart <chris.hakkaart@seqera.io>
Remove extra lines Signed-off-by: Chris Hakkaart <chris.hakkaart@seqera.io>
Collaborator
christopher-hakkaart
left a comment
There was a problem hiding this comment.
I cleaned up the PR so the preview is generated. I've also made suggestions to remove the list and a link that didn't exist, and reduce some of the text. Please check the meaning is retained.
Signed-off-by: Chris Hakkaart <chris.hakkaart@seqera.io>
christopher-hakkaart
approved these changes
Nov 11, 2025
Collaborator
christopher-hakkaart
left a comment
There was a problem hiding this comment.
Sorry - I was OoO for a few days and forgot to comment this. This looks good to me now. I'll ask @bentsherman to give it a quick look to make sure everything is correct, then it should be good to merge.
bentsherman
reviewed
Nov 12, 2025
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist: Improve
task.previousTraceDocumentationSummary of Changes
This PR enhances the documentation for the
task.previousTracefield to provide explicit guidance on accessing runtime metrics from previous task attempts. The changes address user confusion around field availability and access patterns, particularly for implementing retry logic based on performance metrics.Key Improvements
task.previousTracep-naming pattern for percentage fields (workaround for Groovy syntax limitations with%)Pre-Submission Checklist
Code Quality
Documentation
Testing
pcpupmem) are correctly explainedReview Readiness
Completeness
Detailed Change Summary
Documentation Enhancements
task.previousTrace(e.g., memory usage, CPU metrics)pcpupmempattern as a Groovy workaround for percentage fields (can't use%directly in identifiers)Files Modified
task.previousTracefield referenceImpact
Review Notes
For Reviewers: Please verify that all field names and access patterns match the actual implementation in the codebase. Pay particular attention to:
pcpupmemnaming explanation