Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (57 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

80 lines (57 loc) · 1.54 KB
Raw

Contributing

Prerequisites

  • Access to the Keybase team epfl_actu.
  • Access to the three different OpenShift environments (dev | test | prod)

Setup

Clone the repository:

git clone git@github.com:epfl-si/actu.git

Optionally, for better integration with IDEs:

  1. Install pyenv.
  2. make create-venv.
  3. Install nvm.
  4. npm install.

Help

make help

Build / Run

make local-up     # local Django development server (automatic reloads)

Tests

Lint code, unit tests and integration tests

make test

Coverage

make coverage        # text report
# or
make coverage-html   # html report

Clone Database

make local-clone      # Clones production database into the local environment.
# or
make dev-clone        # Clones production database to the dev environment.
# or
make staging-clone    # Clones production database to the staging environment.

Release

  1. Update the CHANGELOG.md.
  2. Bump app_image_tag to the new version in all three Ansible inventory files:
    • ansible/inventory/dev.yml
    • ansible/inventory/test.yml
    • ansible/inventory/prod.yml
  3. Push and merge to main branch.
  4. Create and push a new tag:
    git tag -a <version_number> -m "Actu - <version_number>"
    git push origin main --tags
  5. Wait for the new image to be built.

Deploy

Run the actusible script with an environment :

./ansible/actusible [ --dev | --test | --prod ]