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

Change how sample environment variables are stored in the repository #793

Merged
merged 4 commits into from
Oct 28, 2023
Merged

Change how sample environment variables are stored in the repository #793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3c9ef3c
Add .env.sample file
dchiller Oct 27, 2023
a0454eb
Remove .env from git index
dchiller Oct 27, 2023
6f05637
Update README for new env structure
dchiller Oct 27, 2023
77075d4
Update GitHub actions with additional env variables
dchiller Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .env → .env.sample
View file
Open in desktop
File renamed without changes.
6 changes: 5 additions & 1 deletion .github/workflows/lint_and_test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ jobs:
run-tests:
runs-on: ubuntu-latest
env:
POSTGRES_DB: test_cu
POSTGRES_USER: admin
POSTGRES_PASSWORD: supersecurepassword99
RABBIT_VHOST: test_cu
RABBIT_USER: admin
RABBIT_PASSWORD: supersecurepassword99
steps:
- uses: actions/checkout@v3
- run: docker compose build
- run: docker compose up -d
- run: docker compose exec -T app python runtests.py cantusdata.test.core
- run: docker compose exec -T app python runtests.py cantusdata.test.core
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ IntelliJ Idea files
/public/media/*
/public/htmlcov/*
*.coverage

.env
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ git submodule update --init
We use [Docker Compose](https://docs.docker.com/compose/) to containerize each service and keep all our dependencies in order. Cantus Ultimus is compatible with Docker Compose > 2.8.

### The `.env` file
The build process relies on environment variables specified in the `.env` file, which is located at the root of the repository.
The build process relies on environment variables specified in an `.env` file located at the root of the repository. A sample of this file, `.env.sample`, is provided.

You must make two modifications to this file before the docker containers will build. Both `POSTGRES_PASSWORD` and `RABBIT_PASSWORD` should be uncommented and set with secure passwords.
Make a copy of `.env.sample` and name it `.env`. You must make two modifications to this file before the docker containers will build. Both `POSTGRES_PASSWORD` and `RABBIT_PASSWORD` should be uncommented and set with secure passwords.

#### Handling `postgres` authentication issues

Expand Down