From 064ac6811c8012271d7a5cf332d4fcc6f3214ddf Mon Sep 17 00:00:00 2001
From: Evgenii Alekseev <i@arcanis.me>
Date: Mon, 6 Nov 2023 23:25:29 +0200
Subject: [PATCH] build: rename push action to release

---
 CONTRIBUTING.md | 22 ++++++++++++++++++++++
 Makefile        |  4 ++--
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 954d121f..1f64bd1f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -225,3 +225,25 @@ Again, the most checks can be performed by `make check` command, though some add
 ### Other checks
 
 The projects also uses typing checks (provided by `mypy`) and some linter checks provided by `pylint` and `bandit`. Those checks must be passed successfully for any open pull requests.
+
+## Developers how to
+
+### Run automated checks
+
+```shell
+make check tests
+```
+
+### Generate documentation templates
+
+```shell
+make specification
+```
+
+### Create release
+
+```shell
+make VERSION=x.y.z check tests release
+```
+
+The command above will also run checks first and will generate documentation, tags, etc., and will push them to GitHub. Other things will be handled by GitHub workflows automatically.
diff --git a/Makefile b/Makefile
index be5b50dd..4cc06a12 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: archive archlinux check clean directory html push specification tests version
+.PHONY: archive archlinux check clean directory html release specification tests version
 .DEFAULT_GOAL := archlinux
 
 PROJECT := ahriman
@@ -37,7 +37,7 @@ html: specification
 	rm -rf docs/html
 	tox -e docs-html
 
-push: specification archlinux
+release: specification archlinux
 	git add package/archlinux/PKGBUILD src/ahriman/__init__.py docs/ahriman-architecture.svg package/share/man/man1/ahriman.1 package/share/bash-completion/completions/_ahriman package/share/zsh/site-functions/_ahriman
 	git commit -m "Release $(VERSION)"
 	git tag "$(VERSION)"