#224: Release procedure docs

Electron/src/global/global.ts

@@ -2,7 +2,6 @@ import SongArchitecture from './SongArchitecture';
 
 namespace Global {
   export const backendBaseUrl: string = 'http://127.0.0.1:8000';
-  export const appVersion: string = '1.0.0';
 
   export const repositoryUrl: string =
     'https://github.com/AntonioMrtz/SpotifyElectron/';

docs/frontend/Package-app.md

@@ -2,12 +2,22 @@
 
 In this section we will cover how to package app for production. After following the steps the generated installer will be placed at `Electron/release/build`.
 
-## 1. Select wanted architecture in global.ts
+## 1. Update `global.ts` client data
+
+### Select desired architecture
 
 ```ts
 export const songArchitecture: SongArchitecture = SongArchitecture.FILE_ARCHITECTURE;
 ```
 
+### Update production backend url
+
+❗ Set backend url path without trailing `/`
+
+```ts
+export const backendBaseUrl: string = 'http://127.0.0.1:8000';
+```
+
 ## 2. Build the app
 console
 ```

docs/utils/Release-Procedure.md

@@ -0,0 +1,57 @@
+# Release procedure
+
+## 1. Update release version info on codebase
+
+### Frontend
+
+Update `package.json` version in:
+
+* `Electron/package.json`
+* `Electron/release/app/package.json`
+
+```json
+{
+  "name": "spotify-electron",
+  "version": "1.0.0",
+  ...
+}
+```
+
+### Backend
+
+Update FastAPI backend version on `Backend/app/common/app_schema.py`
+
+```py
+class AppInfo:
+    ...
+    VERSION = "1.0.0"
+    ...
+```
+
+## 2. Generate release Github
+
+* Generate release in [Github releases](https://github.com/AntonioMrtz/SpotifyElectron/releases/new)
+* Create tag
+* Link code commit with release tag
+
+
+## 3. Packaged app
+
+* Follow [packaging guide](../frontend/Package-app.md) using production backend URL and architecture.
+* Upload exectuables to [Github releases](https://github.com/AntonioMrtz/SpotifyElectron/releases)
+
+## 4. Prepare database
+
+* Prepare data sets
+* Delete non compatible data with new version in database
+
+## 5. Deploy backend cloud service
+
+* Select commit to deploy on cloud
+
+## 6. Misc updates
+
+* [Website](https://github.com/AntonioMrtz/SpotifyElectron_Web)
+* Linkedin
+* Portfolio
+* Github readme and docs

mkdocs.yml

@@ -29,9 +29,10 @@ nav:
       - Package app: frontend/Package-app.md
       - FAQ: frontend/FAQ.md
   - Utils:
+    - Release procedure: utils/Release-Procedure.md
     - OpenAPI schema generation & usage: utils/OpenAPI.md
-    - Generate Mock data: utils/Generate-Mock-Data.md
     - Mkdocs development & usage: utils/Mkdocs.md
+    - Generate Mock data: utils/Generate-Mock-Data.md
   - Code of conduct: CODE_OF_CONDUCT.md
   - Contributors: CONTRIBUTORS.md