Document CI setup (AppVeyor/Codecov/Travis) #907
Labels
kind: enhancement
Label for issues suggesting enhancements; and for pull requests implementing enhancements
topic: ci
Anything related to GitHub Actions, Codecov, AppVeyor, Coveralls, Travis, ...
topic: documentation
Issues and PRs related to documentation
topic: tests
issues or PRs related to tests
topic: workflow
Meta: anything related to the development workflow of GAP
We should document out test setup somwhere. E.g. by adding some helpful explanatory comments to
etc/ci.sh
, and/or in a Wiki page, and/or in a text document in thedoc/
dir or whatever.As it is, right now if anything were to break regarding Travis, AppVeyor, Codecov, the only thing one can do is to email the mailing list and/or directly Alex, Markus, Chris, and hope one of them is able to fix it.
Based on past experiences in other OSS projects, I think this is somewhat problematic. For example, if nobody touches the setup for half a year (because everything works great -- yay!), they may have forgotten some steps. And if people for some reasons are not available, somebody else needs to "reverse engineer" it.
This documentation need not be very long and complex, to the contrary. A summary of how the integration works, where one can find the relevant settings etc. is enough.
UPDATE: some concrete things that should be documented:
citests
in Makefile? #1740)But I think instead of writing everything down one might think of, it's best to do this: take some helpful person who wants to learn about these things; let them start looking for themselves (with access to the documentation of Traivs and all). Then sit next or near to them, and encourage them to ask questions if they get stuck. Use this to decide what kinds of pointers are helpful, then just write those, and for the rest, rely on the service's existing information (to which we may also link, of course)
The text was updated successfully, but these errors were encountered: