From 8aaff8ca4a4ee99c28927da3b0bbef9922048ebf Mon Sep 17 00:00:00 2001 From: Alexander Bigga Date: Fri, 3 Nov 2023 10:51:20 +0100 Subject: [PATCH] Update documenation about publish new versions (#422) * Change publish job in Makefile to not push into main * Makefile requries tabs instead spaces --- .editorconfig | 4 ++++ Makefile | 7 ++++--- mkdocs/docs/development.md | 6 ++++++ 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.editorconfig b/.editorconfig index c1e2c643..5e52e6e5 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,3 +10,7 @@ end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true + +[{Makefile,**.mk}] +# Use tabs for indentation (Makefiles require tabs) +indent_style = tab diff --git a/Makefile b/Makefile index ca94ccb9..cbf33a07 100644 --- a/Makefile +++ b/Makefile @@ -48,10 +48,11 @@ publish: @read -p "which version do you want to publish now (start with number, NO v): " newversion; \ sed -i "s/Version.*/Version:\ $$newversion/" "sass/style.scss" && \ php create-changelog.php $$newversion && \ + git checkout -B deploy && \ git add sass/style.scss changelog.html && git commit -m "publishing version $$newversion" && \ - git tag "v$$newversion" - git push && git push --tags - make deploy + git push +# git tag "v$$newversion" +# git push && git push --tags mkdocs-serve: diff --git a/mkdocs/docs/development.md b/mkdocs/docs/development.md index 09e07f5b..f4bdd154 100644 --- a/mkdocs/docs/development.md +++ b/mkdocs/docs/development.md @@ -39,3 +39,9 @@ Fertig. Das Deployment läuft über GitHub Actions. Beim Erstellen eines Releases wird das CSS und JavaScript gebaut und das ZIP-Archiv gepackt und auf dem Updateserver https://sunflower-theme.de kopiert. Wichtig: Vor dem Release die Versions-Nummer in `sass/style.scss` anpassen! + +Dazu kann man den Schritt `publish` des Makefiles nutzen: + +`make publish` + +Dadurch wird ein neuer Branch `deploy` angelegt, die Versions-Nummer in `sass/style.scss` gesetzt, das Changelog aktualisiert und der Branch gepusht.