From ea5b86c351f5762aa0c4e02e794101a064e7436e Mon Sep 17 00:00:00 2001 From: abonyibence <abonyibence@sch.bme.hu> Date: Thu, 8 May 2025 15:16:57 +0200 Subject: [PATCH] added semantic versioning description --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0fe83cc..62183f6 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ - [BecskasszaSCH 2 | README](#becskasszasch-2--readme) - [Tartalom](#tartalom) +- [Fejlesztés](#fejlesztés) + - [Semantic release](#semantic-release) - [Setup - OLVASD EL!!!!](#setup---olvasd-el) - [Környezeti változókat tartalmazó fájl létrehozása](#környezeti-változókat-tartalmazó-fájl-létrehozása) - [Lokálisan Postgresql-el (Docker nélkül)](#lokálisan-postgresql-el-docker-nélkül) @@ -44,6 +46,20 @@ - [Hibakeresés](#hibakeresés) - [Dockerrel](#dockerrel) +# Fejlesztés +Ez a rész leírja, hogy hogyan kell a változtatásaid feltölteni úgy, hogy az productionbe menjen ki. + +## Semantic release +A becskasszaschv2 semantic-releaset használ, aminek lényege a verziózás automatizálása. +Ez a folyamat az alkalmazás deployolásának a fontos része, ugyanis tagelés hatására fog megépülni az új docker image. +Ahhoz, hogy ezt használjuk, a commit messagebe kell szöveget írni, az alábbi séma szerint `git commit -m "<keyword>: <your_commit_message>"` +A keywordok az alábbiak: + - **fix**: patch verziót növel + - **refactor**: patch verziót növel + - **feat**: minor verziót növel + - **BREAKING**: major verziót növel + +Ezen felül a deployolás teljesen automatikusan történik, plz don't break!!! # Setup - OLVASD EL!!!! -- GitLab