search

astropy / package-template

Template for packages that use Astropy. Maintainer: @astrofrog
http://docs.astropy.org/projects/package-template/en/latest/
Other
60 stars 62 forks source link

Do not ship commented out config for CI #504

Closed bsipocz closed 1 year ago

bsipocz commented 3 years ago

Many years of experience shows that commented out CI config is the wrong approach to ship this template. I strongly suggest to either make them opt in at cookicutter time, or just simply have them enabled in the matrix. The current approach doesn't answer to the question of why those are commented out, what their purpose is and what extra they bring if they are not commented out.

https://github.com/astropy/package-template/blob/cookiecutter/%7B%7B%20cookiecutter.package_name%20%7D%7D/.github/workflows/ci_tests.yml#L50

pllim commented 3 years ago

@tepickering , do you remember why they were commented out?

tepickering commented 3 years ago

iirc, there was a complaint that the default matrix was too large. so i commented them out to leave as ready-to-implement examples if users wanted to cover those cases. they're less-commonly used edge-ish cases so probably best to remove them. is there documentation somewhere on the use of github actions w/in the astropy ecosystem and recommended best practices? if it exists, that could be pointed to for guidance and examples...

pllim commented 1 year ago

https://github.com/astropy/package-template#deprecation-warning