search

nextflow-io / nextflow

A DSL for data-driven computational pipelines
http://nextflow.io
Apache License 2.0
2.78k stars 632 forks source link

Better migration notes for breaking changes #3459

Open corneliusroemer opened 1 year ago

corneliusroemer commented 1 year ago

I think it could be helpful to call out breaking changes more visibly in the change log.

E.g., you changed the default behaviour of rolling trace/report numbers that caused things to break without a note telling the user why, see https://github.com/nextflow-io/nextflow/issues/3334#issuecomment-1299007619

I couldn't find any announcement for this type of breaking change that wasn't buried in dozens of lines of merged PRs.

It would be good if: ~a) there was a note telling the user how to overwrite the report~ this has already been implemented in https://github.com/nextflow-io/nextflow/commit/d20e4ba8ded0817ce6078a745e1a4a4f5516bd8e b) call this sort of potential issue out in the release notes so that users can find it more easily rather than having to file a bug report

bentsherman commented 1 year ago

Thanks for the suggestion. We're usually pretty good about including doc updates with each feature PR, for some reason it was left out of that feature and I had to add it after the fact. Even still, I agree that we should point out breaking changes in the release notes in addition to listing the commits.

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.