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

Document CI setup (AppVeyor/Codecov/Travis) #907

Open
fingolfin opened this issue Sep 29, 2016 · 1 comment
Open

Document CI setup (AppVeyor/Codecov/Travis) #907

fingolfin opened this issue Sep 29, 2016 · 1 comment
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

Comments

@fingolfin
Copy link
Member

fingolfin commented Sep 29, 2016

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 the doc/ 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:

  • what CI services we use (Travis, AppVeyor; more in the future?)
  • what coverage services we use (Codecov, Coveralls)
    • how to
  • how it all works (discuss .travis.yml, stuff in etc/ ?)
  • admin information:
    • how to give people access to AppVeyor so that they can restart or cancel jobs?

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)

@fingolfin fingolfin added the topic: documentation Issues and PRs related to documentation label Sep 29, 2016
@markuspf markuspf self-assigned this Oct 3, 2016
@markuspf markuspf added this to the GAP 4.9.0 milestone Oct 3, 2016
@olexandr-konovalov olexandr-konovalov added the topic: tests issues or PRs related to tests label Feb 21, 2017
@fingolfin fingolfin added the kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements label May 9, 2017
@fingolfin fingolfin removed this from the GAP 4.9.0 milestone Nov 8, 2017
@fingolfin
Copy link
Member Author

While this would be nice to have, I don't think it's mandatory for 4.9.0, hence I just removed the milestone. Perhaps we can try to get this into 4.10.0.

@fingolfin fingolfin added the topic: workflow Meta: anything related to the development workflow of GAP label Mar 26, 2019
@ruthhoffmann ruthhoffmann added gapdays2020-spring Issues and PRs that arose in relation to https://www.gapdays.de/gapdays2020-spring topic: ci Anything related to GitHub Actions, Codecov, AppVeyor, Coveralls, Travis, ... labels Nov 6, 2019
@fingolfin fingolfin removed the gapdays2020-spring Issues and PRs that arose in relation to https://www.gapdays.de/gapdays2020-spring label Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

4 participants