consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a note regarding CI when running the tests

Browse Source 
Many developers run `bin/rspec` and then are (reasonably) confused when
running the tests takes too long.

So we're clarifying that running the whole test suite should be done
using a CI, and only relevant tests should be run while developing on
your machine.
This commit is contained in:
Javi Martín
2024-06-07 20:17:03 +02:00
parent 3aa75d62c4
commit 16008b5788
2 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -50,12 +50,14 @@ Run the app locally:
bin/rails s bin/rails s
``` ```
Run the tests with: You can run the tests with:
```bash ```bash
bin/rspec bin/rspec
``` ```
Note: running the whole test suite on your machine might take more than an hour, so it's strongly recommended that you setup a Continuous Integration system in order to run them using parallel jobs every time you open or modify a pull request (if you use GitHub Actions or GitLab CI, this is already configured in `.github/workflows/tests.yml` and `.gitlab-ci.yml`) and only run tests related to your current task while developing on your machine. When you configure the application for the first time, it's recommended that you run at least one test in `spec/models/` and one test in `spec/system/` to check your machine is properly configured to run the tests.
You can use the default admin user from the seeds file: You can use the default admin user from the seeds file:
**user:** admin@consul.dev **user:** admin@consul.dev

2
README_ES.md
View File

@@ -55,6 +55,8 @@ Para ejecutar los tests:
bin/rspec bin/rspec
``` ```
Nota: ejecutar todos los tests en tu máquina puede tardar más de una hora, por lo que recomendamos encarecidamente que configures un sistema de Integración Continua para ejecutarlos utilizando varios trabajos en paralelo cada vez que abras o modifiques una PR (si usas GitHub Actions o GitLab CI, esto ya está configurado en `.github/workflows/tests.yml` y `.gitlab-ci.yml`) y cuando trabajes en tu máquina ejecutes solamente los tests relacionados con tu desarrollo actual. Al configurar la aplicación por primera vez, recomendamos que ejecutes al menos un test en `spec/models/` y un test en `spec/system/` para comprobar que tu máquina está configurada para ejecutar los tests correctamente.
Puedes usar el usuario administrador por defecto del fichero seeds: Puedes usar el usuario administrador por defecto del fichero seeds:
**user:** admin@consul.dev **user:** admin@consul.dev