dev: move commitlint to tools, keeping bin/ for user tools

michj · Dec 11, 2021 · 16124eb · 16124eb
1 parent 9ca6810
commit 16124eb
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 16 deletions.
diff --git a/.github/workflows/mac.yml b/.github/workflows/mac.yml
@@ -48,9 +48,9 @@ jobs:
       run: |
         RANGE=${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
         git rev-list --quiet $RANGE \
-          && bin/commitlint  $RANGE \
+          && tools/commitlint  $RANGE \
           || ( echo "could not identify commits, not checking them" )
-      #   || ( echo "could not identify commits, checking last $NUM instead:"; bin/commitlint -$NUM )
+      #   || ( echo "could not identify commits, checking last $NUM instead:"; tools/commitlint -$NUM )
 
     - name: Skip remaining CI steps if latest commit message begins with ;
       shell: bash

diff --git a/.github/workflows/pull.yml b/.github/workflows/pull.yml
@@ -75,7 +75,7 @@ jobs:
     #     echo "$GITHUB_HEAD_REF"
     #     echo "$GITHUB_BASE_REF"
     #     git log "$GITHUB_BASE_REF"..
-    #     bin/commitlint "$GITHUB_BASE_REF"..
+    #     tools/commitlint "$GITHUB_BASE_REF"..
 
     # keep synced in all workflows which do this
     - name: Check commit messages
@@ -91,9 +91,9 @@ jobs:
       run: |
         RANGE=${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
         git rev-list --quiet $RANGE \
-          && bin/commitlint  $RANGE \
+          && tools/commitlint  $RANGE \
           || ( echo "could not identify commits, not checking them" )
-      #   || ( echo "could not identify commits, checking last $NUM instead:"; bin/commitlint -$NUM )
+      #   || ( echo "could not identify commits, checking last $NUM instead:"; tools/commitlint -$NUM )
 
     - name: Skip remaining CI steps if latest commit message begins with ;
       shell: bash

diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -66,7 +66,7 @@ jobs:
     #     echo "$GITHUB_HEAD_REF"
     #     echo "$GITHUB_BASE_REF"
     #     git log "$GITHUB_BASE_REF"..
-    #     bin/commitlint "$GITHUB_BASE_REF"..
+    #     tools/commitlint "$GITHUB_BASE_REF"..
 
     # keep synced in all workflows which do this
     - name: Check commit messages
@@ -82,9 +82,9 @@ jobs:
       run: |
         RANGE=${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
         git rev-list --quiet $RANGE \
-          && bin/commitlint  $RANGE \
+          && tools/commitlint  $RANGE \
           || ( echo "could not identify commits, not checking them" )
-      #   || ( echo "could not identify commits, checking last $NUM instead:"; bin/commitlint -$NUM )
+      #   || ( echo "could not identify commits, checking last $NUM instead:"; tools/commitlint -$NUM )
 
     - name: Skip remaining CI steps if latest commit message begins with ;
       shell: bash

diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -41,9 +41,9 @@ jobs:
       run: |
         RANGE=${BEFORE:-origin/master}..${GITHUB_HEAD_REF:+origin/$GITHUB_HEAD_REF}
         git rev-list --quiet $RANGE \
-          && bin/commitlint  $RANGE \
+          && tools/commitlint  $RANGE \
           || ( echo "could not identify commits, not checking them" )
-      #   || ( echo "could not identify commits, checking last $NUM instead:"; bin/commitlint -$NUM )
+      #   || ( echo "could not identify commits, checking last $NUM instead:"; tools/commitlint -$NUM )
 
     - name: Skip remaining CI steps if latest commit message begins with ;
       shell: bash

diff --git a/COMMITS.md b/COMMITS.md
@@ -21,7 +21,7 @@ Here they are in brief:
 
 ## When committing / pushing / merging:
 
-- run `bin/commitlint` before push, to check recent commits
+- run `tools/commitlintnt` before push, to check recent commits
 - or, run it automatically before each commit (`make installcommithook` to configure your local repo)
 - it also runs in CI on github for pull requests, etc.
 

diff --git a/Makefile b/Makefile
@@ -1055,8 +1055,8 @@ list-commits: $(call def-help,list-commits, list all commits chronologically and
 ###############################################################################
 $(call def-help-subheading,MISCELLANEOUS:)
 
-installcommithook: $(call def-help,installcommithook, symlink bin/commitlint as .git/hooks/commit-msg)
-	ln -s ../../bin/commitlint .git/hooks/commit-msg
+installcommithook: $(call def-help,installcommithook, symlink tools/commitlint as .git/hooks/commit-msg)
+	ln -s ../../tools/commitlint .git/hooks/commit-msg
 
 watch-%: $(call def-help,watch-RULE, run make RULE repeatedly when any committed file changes)
 	 @git ls-files | entr -r make $*

diff --git a/bin/commitlint → tools/commitlint b/bin/commitlint → tools/commitlint
@@ -127,9 +127,9 @@ More context: https://hledger.org/CONTRIBUTING.html#commit-messages
 
 You can set up this script to check your commit messages locally:
 1. before committing:
-   a. safer but must redo:  cp bin/commitlint .git/hooks/commit-msg
-   b. more convenient:      ln -s ../../bin/commitlint .git/hooks/commit-msg
-2. before pushing:          bin/commitlint && git push
+   a. safer but must redo:  cp tools/commitlint .git/hooks/commit-msg
+   b. more convenient:      ln -s ../../tools/commitlint .git/hooks/commit-msg
+2. before pushing:          tools/commitlint && git push
 ---------------------------------------------------------------------------
 EOF