Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Template: Link to troubleshooting docs when pipeline fails #2845

Merged
merged 3 commits into from
Mar 13, 2024

Conversation

drpatelh
Copy link
Member

The following snippet was removed after v2.12.1 when we refactored the pipeline template to remove the lib/ directory in favour of more granular utils_* subworkflows

workflow.onError {
if (workflow.errorReport.contains("Process requirement exceeds available memory")) {
println("🛑 Default resources exceed availability 🛑 ")
println("💡 See here on how to configure pipeline: https://nf-co.re/docs/usage/configuration#tuning-workflow-resources 💡")
}
}

This PR adds it back in with the aim of catching any error and redirecting users to a single page where we can maintain a list of common errors encountered by users.

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Conceptually works for me, I will do a pass through the troubleshooting page soon.

I will also try to test against other errors but this should work in most cases from my experience.

@mirpedrol mirpedrol changed the title Link to troubleshooting docs when pipeline fails Template: Link to troubleshooting docs when pipeline fails Mar 13, 2024
@mirpedrol
Copy link
Member

@nf-core-bot changelog

Copy link

codecov bot commented Mar 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.84%. Comparing base (47f18ea) to head (eaec765).

Additional details and impacted files

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@drpatelh drpatelh merged commit fcd3ecf into dev Mar 13, 2024
35 checks passed
@drpatelh drpatelh deleted the add_workflow_error_strategy branch March 13, 2024 13:07
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.

4 participants