From a08c63d0166c64d62f6ac961c6a1a56fce708bf6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jorge=20Alberto=20D=C3=ADaz=20Orozco=20=28Akiel=29?= Date: Tue, 9 Aug 2022 16:13:50 +0200 Subject: [PATCH] Rename the docker-compose file to get rid of the annoyance of writing the file name all the time --- .github/workflows/build.yml | 2 +- README.md | 4 +++- docker-compose-test-server.yml => docker-compose.yml | 0 3 files changed, 4 insertions(+), 2 deletions(-) rename docker-compose-test-server.yml => docker-compose.yml (100%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index baec67c..63a088d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,7 +21,7 @@ jobs: - name: Start rocket.chat server uses: isbang/compose-action@v0.1.1 with: - compose-file: docker-compose-test-server.yml + compose-file: docker-compose.yml - name: Set up Python uses: actions/setup-python@v2 with: diff --git a/README.md b/README.md index d3795b7..2b989d8 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,9 @@ Most of the API methods are already implemented. If you are interested in a spec ### Tests We are actively testing :) -Tests run on a Rocket.Chat Docker container so install Docker and docker-compose. To start test server do `docker-compose -f docker-compose-test-server.yml up` and to take test server down `docker-compose -f docker-compose-test-server.yml down` +Tests run on a Rocket.Chat Docker container so install Docker and docker-compose. +1. To start test server do `docker-compose up` and to take test server down `docker-compose down` +2. To run the tests run `pytest` ### Contributing You can contribute by doing Pull Requests. (It may take a while to merge your code but if it's good it will be merged). Please, try to implement tests for all your code and use a PEP8 compliant code style. diff --git a/docker-compose-test-server.yml b/docker-compose.yml similarity index 100% rename from docker-compose-test-server.yml rename to docker-compose.yml