Introduce the downstream pre-commit hook to help us keep docs up to d…

…ate (#161) See the downstream project for more info about usage. We could also add a github action so necessary doc updates are reported in PR comments. https://github.com/twof/downstream Co-authored-by: Alex Reilly <[email protected]>
Yelp · Sep 10, 2021 · c1d5fef · c1d5fef
1 parent fbc7066
commit c1d5fef
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -55,3 +55,7 @@ repos:
         args: ['--baseline', '.secrets.baseline']
         exclude: .*tests/.*|.*yelp/testing/.*|\.pre-commit-config\.yaml|package-lock\.json|.*.html
         language_version: python3.8
+- repo: https://github.com/twof/Downstream
+  rev: 0.1.0
+  hooks:
+    - id: downstream
diff --git a/api/downsteam.yml b/api/downsteam.yml
@@ -0,0 +1,4 @@
+associations:
+  Makefile:
+    - https://github.com/Yelp/beans/wiki/Getting-Started
+    - https://github.com/Yelp/beans/wiki/Contributing
diff --git a/downstream.yml b/downstream.yml
@@ -0,0 +1,4 @@
+associations:
+  Makefile:
+    - https://github.com/Yelp/beans/wiki/Getting-Started
+    - https://github.com/Yelp/beans/wiki/Contributing
diff --git a/frontend/downstream.yml b/frontend/downstream.yml
@@ -0,0 +1,4 @@
+associations:
+  Makefile:
+    - https://github.com/Yelp/beans/wiki/Getting-Started
+    - https://github.com/Yelp/beans/wiki/Contributing