Optionally prevent merge when HISTORY.md isn't updated (#156)

* added mergeable
* removed changelog CI step
* magic text to skip enforcing HISTORY.md updates

Author: King Long Tse

.circleci/changelog-check.sh

@@ -49,12 +49,6 @@ jobs:
       - run: yarn run snyk test --severity-threshold=high
       - run: yarn run snyk monitor
 
-  changelog:
-    <<: *defaults
-    steps:
-      - checkout
-      - run: make release-test
-
   publish:
     <<: *defaults
     steps:
@@ -68,10 +62,6 @@ workflows:
   version: 2
   test_and_publish:
     jobs:
-      - changelog:
-          filters:
-            tags:
-              only: /.*/
       - test:
           filters:
             tags:
@@ -87,7 +77,6 @@ workflows:
       - publish:
           requires:
             - test
-            - changelog
           filters:
             tags:
               only: /v[0-9]+(\.[0-9]+)*(-.+)?/

.circleci/config.yml

@@ -0,0 +1,14 @@
+version: 2
+mergeable:
+  - when: pull_request.*
+    validate:
+    - do: or
+      validate:
+      - do: dependent
+        changed:
+          file: '**/*'
+          required: ['HISTORY.md'] 
+      - do: description
+        must_include:
+          regex: 'New version is not required'
+          message: 'Should cut a new version or explicitly documents new version not required in description'

.github/mergeable.yml

@@ -88,8 +88,4 @@ test-e2e:
 	npx codeceptjs run --steps
 .PHONY: test-e2e
 
-release-test:
-	sh .circleci/changelog-check.sh
-.PHONY: release-test
-
 .DEFAULT_GOAL = test