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.

Sign up for GitHub

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

Jump to bottom

Add a documentation section about running in CI #12

Open
fpapado opened this issue Oct 16, 2019 · 0 comments
Open

Add a documentation section about running in CI #12

fpapado opened this issue Oct 16, 2019 · 0 comments
Labels
documentation good first issue Good for newcomers Hacktoberfest

Comments

@fpapado
Copy link
Owner

fpapado commented Oct 16, 2019

The aim of the module is to run in CI. We should consider how to document that.

Things like:

  1. Installing
  2. Setting log level
  3. Setting the --ci flag in the CLI
  4. Using the CLI vs the runCore options
  5. Options for reporting
  6. Guides to various CI providers

As a more contained example, we could have a guide with 1. through 4., leaving 5. and 6. as future work.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue Good for newcomers Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fpapado