From 6e076789aa646de01353630d863a96ec8215f2af Mon Sep 17 00:00:00 2001
From: Alejandro Saucedo <axsauze@gmail.com>
Date: Sat, 30 Jan 2021 18:39:30 +0000
Subject: [PATCH] Updated docs and makefile for release

---
 Makefile                   | 26 ++------------------------
 docs/overview/ci-tests.rst | 26 ++++++++++++++++++++++++++
 python/README.md           | 33 +--------------------------------
 3 files changed, 29 insertions(+), 56 deletions(-)

diff --git a/Makefile b/Makefile
index 90d25c2dc..52ad66b31 100644
--- a/Makefile
+++ b/Makefile
@@ -153,24 +153,6 @@ vs_run_docs: vs_build_docs
 vs_run_tests: vs_build_tests
 	./build/test/$(VS_BUILD_TYPE)/test_kompute.exe --gtest_filter=$(FILTER_TESTS)
 
-####### Create release ######
-
-update_builder_image:
-	docker build . -f docker-builders/KomputeBuilder.Dockerfile \
-		-t axsauze/kompute-builder:0.2
-	docker push axsauze/kompute-builder:0.2
-
-update_vulkan_sdk:
-	docker build -f builders/Dockerfile.linux . \
-		-t axsauze/vulkan-sdk:0.1
-	docker push axsauze/vulkan-sdk:0.1
-
-create_linux_release:
-	docker run -it \
-		-v $(pwd):/workspace \
-		axsauze/kompute-builder:0.1 \
-		/workspace/scripts/build_release_linux.sh
-
 
 ####### Run CI Commands #######
 
@@ -206,10 +188,6 @@ build_single_header:
 format:
 	$(CLANG_FORMAT_BIN) -i -style="{BasedOnStyle: mozilla, IndentWidth: 4}" src/*.cpp src/include/kompute/*.hpp test/*cpp
 
-clean:
-	find src -name "*gch" -exec rm {} \; || "No ghc files"
-	rm ./bin/main.exe || echo "No main.exe"
-
-run:
-	./bin/main.exe;
+build_changelog:
+	docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator:1.15.2 -e CHANGELOG_GITHUB_TOKEN=${CHANGELOG_GITHUB_TOKEN}
 
diff --git a/docs/overview/ci-tests.rst b/docs/overview/ci-tests.rst
index df29bb7fc..4e32944dc 100644
--- a/docs/overview/ci-tests.rst
+++ b/docs/overview/ci-tests.rst
@@ -75,3 +75,29 @@ Once this installed:
 * You can build the documentation using the `gendocsall` cmake target
 * You can serve the documentation locally using the `mk_run_docs` command in the Makefile
 
+Performing Release
+~~~~~~~~~~~~
+
+In order to perform the release the following steps need to be carried out:
+
+* Build changelog
+    * Generate latest changelog `make `
+* Python Release
+    * Build dependency:
+        * Intsall dependency: `pip install .`
+        * Ensure all tests pass in GPU and CPU: `python -m pytest`
+        * Build distribution `python setup.py sdist bdist_wheel`
+    * Test repo:
+        * Push to test repo `python -m twine upload --repository testpypi dist/*`
+        * Install python dependency: `python -m pip install --index-url https://test.pypi.org/simple/ --no-deps kp`
+        * Ensure all tests pass in GPU and CPU: `python -m pytest`
+    * Prod repo:
+        * Push to test repo `python -m twine upload dist/*`
+        * Install package from prod pypi `pip install kp`
+        * Ensure all tests pass in GPU and CPU: `python -m pytest`
+
+
+```
+```
+
+
diff --git a/python/README.md b/python/README.md
index 8f34e8765..6cf8ba9fe 100644
--- a/python/README.md
+++ b/python/README.md
@@ -1,34 +1,3 @@
-# Python Bindings for Vulkan Kompute
+# Python Package for Vulkan Kompute
 
-## Publishing to pypi
-
-Build source distribution:
-
-```
-python setup.py sdist bdist_wheel
-```
-
-Push to test pypi registry:
-
-```
-python -m twine upload --repository testpypi dist/*
-```
-
-Install from test pypi:
-
-```
-python -m pip install --index-url https://test.pypi.org/simple/ --no-deps kp
-```
-
-Run tests in python/test directory:
-
-```
-python -m pytest
-```
-
-Push to official pypi registry:
-
-```
-python -m twine upload dist/*
-```