From ef70ddc1fb2800e340de50bcdb3cef2d34cc3b11 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Thu, 3 Nov 2022 09:05:44 +0300
Subject: Initialise the Auth(entic|oris)ation packages

Initialise the authentication/authorisation system packages and set up the
initial database migrations to set up the system.

* README.md: Add documentation on migrations
* gn3/auth/__init__.py: init package
* gn3/auth/authentication/__init__.py: init package
* gn3/auth/authorisation/__init__.py: init package
* gn3/migrations.py: provide migration utilities
* migrations/auth/20221103_01_js9ub-initialise-the-auth-entic-oris-ation-database.py:
  new migration
* tests/unit/auth/test_init_database.py: test new migration applies and rolls
  back as expected
* tests/unit/conftest.py: fixtures for unit tests
* yoyo.auth.ini: basic configuration for yoyo-migration for auth system
  migrations
---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8ddf757..36084c4 100644
--- a/README.md
+++ b/README.md
@@ -95,6 +95,36 @@ and try again. Also make sure your ~/guix-bioinformatics is up to date.
 
 See also instructions in [.guix.scm](.guix.scm).
 
+## Migrations
+
+**NOTE**: Do not create migration scripts manually. Use the processes indicated below.
+
+### Authentication/Authorisation Migrations
+
+The migration scripts for the authentication and authorisation system are in the *migrations/auth* folder in the root of the repository.
+
+To create an new migration, do:
+
+```bash
+$ yoyo new --config=yoyo.auth.ini -m "<description of the migration>"
+```
+
+That initialises an new migration script under the *migrations/auth* folder and gives it a name derived from the date, the sequence for that day, and the provided description.
+
+e.g.
+
+```bash
+$ yoyo new --config=yoyo.auth.ini -m "testing a new migration"
+Error: could not open editor!
+Created file ./migrations/auth/20221103_02_HBzwk-testing-a-new-migration.py
+```
+
+Now you can open and edit the scripts to provide the appropriate SQL statements to update or rollback your schema.
+
+### Running the Migrations
+
+**TODO**: Document how to run the migrations
+
 ## Running Tests
 
 (assuming you are in a guix container; otherwise use venv!)
-- 
cgit v1.2.3