search

TuringLang / docs

Documentation and tutorials for the Turing language
https://turinglang.org/docs/
MIT License
231 stars 99 forks source link

CompatHelper opens dozens of pull requests #215

Closed rikhuijzer closed 3 years ago

rikhuijzer commented 3 years ago

Currently, the tutorials all have their own environment. This causes CompatHelper to open dozens of pull requests when multiple dependencies should be updated. Even when these are resolved, one new package version may introduce 10 new pull requests (one per tutorial).

I would suggest moving to one global environment to avoid spamming the 10 people who watch this repository, but I also understand that there are drawbacks to having one environment.

@devmotion, @torfjelde, @cpfiffer, any thoughts?

EDIT: Apologies for the mess this has caused, by the way. I could have predicted that we would end up with 87 PRs.

torfjelde commented 3 years ago

If that's the only alternative (what do they do over at SciML?), then IMO we should instead just not use CompatHelper here. Global env is unfortuante because eventually we'll have a lot of deps for all tutorials leading to unnecessary bloat, increased compile-times, etc. IMO we want the tutorials to be something people can actually open up and play around with; a global env IMO goes against that.

rikhuijzer commented 3 years ago

Global env is unfortuante because eventually we'll have a lot of deps for all tutorials leading to unnecessary bloat, increased compile-times, etc.

Okay, very good point.

what do they do over at SciML?

There, they get multiple PRs and merge those. For example:

devmotion commented 3 years ago

Global env is unfortuante because eventually we'll have a lot of deps for all tutorials leading to unnecessary bloat, increased compile-times, etc. IMO we want the tutorials to be something people can actually open up and play around with; a global env IMO goes against that.

I agree, IMO we should really not use a global environment. It leads to a lot of unnecessary dependencies for individual tutorials, makes it more difficult to update the tutorials, and increases the probability of package conflicts. If the packages are somewhat mature, hopefully breaking updates don't occur too often and we just have to cope with the PRs (if we do not rebuild all tutorials it will also not put too much stress on GH actions).

rikhuijzer commented 3 years ago

Okay. I’m convinced. Thank you both!