Encrypt config.yaml

Bug: T348476
toolforge · Oct 11, 2023 · a7c1798 · a7c1798
1 parent 822379a
commit a7c1798
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,3 @@
+# Directory entries are not enough to encrypt fines beneath it
+# https://github.com/AGWA/git-crypt#gitattributes-file
+quarry/config.yaml filter=git-crypt diff=git-crypt
diff --git a/.gitignore b/.gitignore
@@ -8,7 +8,6 @@ __pycache__/
 .venv/
 venv/
 node_modules/
-config.yaml
 .vagrant/
 .coverage
 .python-version

diff --git a/README.md b/README.md
@@ -71,3 +71,12 @@ Bug: <ticket number>
 
 For example:
 Bug: T317566
+
+## git-crypt ##
+
+git-crypt is used to encrypt the config.yaml file. To decrypt ask a maintainer for the decryption key and:
+```
+git clone https://github.com/toolforge/quarry.git
+cd quarry
+git-crypt unlock <path to decryption key>
+```
diff --git a/quarry/config.yaml b/quarry/config.yaml