Merge pull request #73 from pimoroni/patch-user-projects-readme
[EVA-2020-02-2.git] / Makefile
index b59f0c3e5d2e4686a5e91a77ee9df06bd7552115..d2bba49882d41fc69cc3ab4df7c6cb87031e972e 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,8 +1,10 @@
-LIBRARY_VERSION=`cat library/setup.py | grep version | awk -F"'" '{print $$2}'`
-LIBRARY_NAME=`cat library/setup.py | grep name | awk -F"'" '{print $$2}'`
+LIBRARY_VERSION=$(shell grep version library/setup.cfg | awk -F" = " '{print $$2}')
+LIBRARY_NAME=$(shell grep name library/setup.cfg | awk -F" = " '{print $$2}')
 
 .PHONY: usage install uninstall
 usage:
 
 .PHONY: usage install uninstall
 usage:
+       @echo "Library: ${LIBRARY_NAME}"
+       @echo "Version: ${LIBRARY_VERSION}\n"
        @echo "Usage: make <target>, where target is one of:\n"
        @echo "install:       install the library locally from source"
        @echo "uninstall:     uninstall the local library"
        @echo "Usage: make <target>, where target is one of:\n"
        @echo "install:       install the library locally from source"
        @echo "uninstall:     uninstall the local library"
@@ -13,6 +15,7 @@ usage:
        @echo "python-clean:  clean python build and dist directories"
        @echo "python-dist:   build all python distribution files"
        @echo "python-testdeploy: build all and deploy to test PyPi"
        @echo "python-clean:  clean python build and dist directories"
        @echo "python-dist:   build all python distribution files"
        @echo "python-testdeploy: build all and deploy to test PyPi"
+       @echo "tag:           tag the repository with the current version"
 
 install:
        ./install.sh
 
 install:
        ./install.sh
@@ -22,20 +25,25 @@ uninstall:
 
 check:
        @echo "Checking for trailing whitespace"
 
 check:
        @echo "Checking for trailing whitespace"
-       @! grep -IUrn --color "[[:blank:]]$$" --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO
+       @! grep -IUrn --color "[[:blank:]]$$" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO
        @echo "Checking for DOS line-endings"
        @echo "Checking for DOS line-endings"
-       @! grep -IUrn --color "\r" --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile
+       @! grep -IUrn --color "\r" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile
        @echo "Checking library/CHANGELOG.txt"
        @cat library/CHANGELOG.txt | grep ^${LIBRARY_VERSION}
        @echo "Checking library/${LIBRARY_NAME}/__init__.py"
        @cat library/${LIBRARY_NAME}/__init__.py | grep "^__version__ = '${LIBRARY_VERSION}'"
 
        @echo "Checking library/CHANGELOG.txt"
        @cat library/CHANGELOG.txt | grep ^${LIBRARY_VERSION}
        @echo "Checking library/${LIBRARY_NAME}/__init__.py"
        @cat library/${LIBRARY_NAME}/__init__.py | grep "^__version__ = '${LIBRARY_VERSION}'"
 
+tag:
+       git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
+
 python-readme: library/README.rst
 
 python-license: library/LICENSE.txt
 
 python-readme: library/README.rst
 
 python-license: library/LICENSE.txt
 
-library/README.rst: README.md
+library/README.rst: README.md library/CHANGELOG.txt
        pandoc --from=markdown --to=rst -o library/README.rst README.md
        pandoc --from=markdown --to=rst -o library/README.rst README.md
+       echo "" >> library/README.rst
+       cat library/CHANGELOG.txt >> library/README.rst
 
 library/LICENSE.txt: LICENSE
        cp LICENSE library/LICENSE.txt
 
 library/LICENSE.txt: LICENSE
        cp LICENSE library/LICENSE.txt