Merge pull request #62 from Picorims/develop

release 0.3.3

CHANGELOG.md

@@ -2,7 +2,13 @@
 This document is based on Keep a Changelog 1.0.0
 https://keepachangelog.com/en/1.0.0/
 
-## 0.3.2-indev (2023-02-02)
+## 0.3.3-beta (2023-02-04)
+
+### Fixed
+- Fixed: FPS, screen size and JPEG export inputs are completely broken (MSI installation) (#59) 
+- Fixed: The open logs folder is broken (#58) 
+
+## 0.3.2-beta (2023-02-02)
 
 ### Changed
 - The side panel is now resizable.

docs/DEVELOPMENT_GUIDELINES.md

@@ -16,6 +16,7 @@
 - [Documenting](#documenting)
 - [Creating UI components](#ui-components)
 - [Versioning and Git](#versioning-and-git)
+- [Doing a release](#doing-a-release)
 - [Questions or concerns ?](#questions-or-context)
 - [FAQ](#faq)
 
@@ -372,6 +373,66 @@ It is (again) arguably not as convenient as a framework introducing custom synta
 
 > Note: **Do NOT use Git LFS!** It caused many issues in the past and should not be touched or used anymore.
 
+<a name="doing-a-release"></a>
+
+## Doing a release
+
+1) verify the version number and type **( /!\ indev -> beta /!\ )** in:
+    - `package.json`
+    - `package.lock.json`
+    - `index.js`
+2) update [CHANGELOG.md](../CHANGELOG.md)
+
+3) comment out the `openDevTools` line in window functions in main.js
+4) do necessary fixes
+
+5) push to master
+
+6) `npm run make` (for local testing or manual builds)
+7) test the maked files (if not ok go back to #4)
+
+8) merge the release from `develop` to `main`
+
+9) tag locally on `main` (`git tag -a v1.4 -m "my version 1.4"`)
+10) commit the tag (`git push origin --tags` or `git push origin tag_name`)
+> **to get rid of a tag:**
+> - `git tag -d v1.4-lw`
+> - `git push origin --delete <tagname>`
+11)
+    - **local build:**
+        - Do the GitHub release with appropriate packages and the right tag (source code already managed BUT without node modules)
+    - **CI build:**
+        - Wait for the tag CI action to finish. It will produce a release draft for the tag, with built packages attached to it.
+12) Fill the release information:
+```md
+[description]
+
+# Changelog
+- a
+- b
+
+# Known issues
+- a
+- b
+
+# Note on Betas
+Wav2Bar is currently in beta, which means that things actively change (UI, saves, etc.)! Please **backup your saves**, especially when updating Wav2Bar.
+
+# Note for Linux
+Right now Linux is not very well supported, but I try my best to make it better bit by bit. For now you should be able to use Wav2Bar without much problem by using the zipped version or using the source code after installing the dependencies (see the README or the wiki). There are some predefined (but not tested) configs to make some other linux packages that you can try.
+
+# Note for Mac
+Mac is not supported at this moment, but you can give it a try using the source code (see the README or the wiki).
+
+
+# Support
+For bug reports, please use the issues section of GitHub. For other support, use the discussions section or go over to my Discord server (https://discord.gg/EVGzfdP)
+```
+
+13) Update the website links and release numbers (hard coded, yes I know what you will say, and it is OK as is for me right now).
+14) OPTIONAL : Blog post
+15) Do an archive of the Git repository and GitHub assets
+
 <a name="questions-or-concerns"></a>
 
 ## Questions or concerns ?

index.html

@@ -173,7 +173,7 @@
                         </div> -->
                         <ui-parameter data-help="experimental_jpeg_export">
                             <ui-input-field id="experimental-export-input"
-                                data-name="Save directory"
+                                data-name="Use JPEG for frames export"
                                 data-type="bool"
                                 data-value="false">
                             </ui-input-field>

js/index.js

@@ -19,7 +19,7 @@
 const {ipcRenderer} = require("electron");
 
 /** @type {String} current build version*/
-const software_version = "0.3.2-beta";
+const software_version = "0.3.3-beta";
 /** @type {String} current build type */
 let working_dir; //working directory for user, temp, logs...
 let root_dir; //root of the app (where main.js is located, and html/css folders)

js/ui_components/web_ui_input_field/web_ui_input_field.js

@@ -49,14 +49,17 @@ export class WebUIInputField extends WebUICustomComponent {
             props: {...PROPS_DEFAULTS},
         });
 
+        this.onDOMReadyOnce(() => {
+            this.bindProps(PROPS.value, bind_input, bind_input.PROPS.value);
+            this.bindProps(PROPS.type, bind_input, bind_input.PROPS.type);
+            this.bindProps(PROPS.name, label_block, label_block.PROPS.name);
+        });
+
         /** @type {uiComponents.WebUIBindInput} */
         let bind_input = this._shadow_root.querySelector(".ui-input-field-bind");
-        this.bindProps(PROPS.value, bind_input, bind_input.PROPS.value);
-        this.bindProps(PROPS.type, bind_input, bind_input.PROPS.type);
 
         /** @type {uiComponents.WebUILabelBlock} */
         let label_block = this._shadow_root.querySelector(".ui-input-field-label");
-        this.bindProps(PROPS.name, label_block, label_block.PROPS.name);
 
         // /** @type {HTMLInputElement} */
         let input = this._shadow_root.querySelector(".ui-input-field-input");

main.js

@@ -575,6 +575,7 @@ ipcMain.handle("open-local-html", async (event, link) => {
  * @param {String} path_to_open
  */
 ipcMain.handle("open-folder-in-file-explorer", async (event, path_to_open) => {
+    if (process.platform === "win32") path_to_open = path_to_open.replaceAll("/","\\");
     main_log.warn(`opening ${path_to_open}.`);
     var regexp = new RegExp(/^\.\//);
     if (regexp.test(path_to_open)) path_to_open = path.join(__dirname, path_to_open);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wav2bar",
-  "version": "0.3.2-beta",
+  "version": "0.3.3-beta",
   "description": "A tool to create and export audio visualization mainly for the music industry",
   "main": "main.js",
   "scripts": {