chore: add release workflow

.github/workflows/release.yml

@@ -0,0 +1,135 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        type: string
+        description: New version number in X.Y.Z
+        required: true
+
+jobs:
+  push-version-number:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone develop repository
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT }}
+          ref: 'develop'
+
+      - name: Push version number
+        shell: bash
+        run: |
+          npm version --no-git-tag-version ${{ github.event.inputs.version }}
+
+      - name: git add & commit & push
+        uses: EndBug/add-and-commit@v9
+        with:
+          add: 'package.json package-lock.json'
+          default_author: github_actions
+          message: 'chore: push version number to v${{ github.event.inputs.version }}'
+          tag: 'v${{ github.event.inputs.version }}'
+          push: true
+
+  update-master-branch:
+    needs: ['push-version-number']
+    runs-on: ubuntu-latest
+    steps:
+      - uses: everlytic/branch-merge@1.1.5
+        with:
+          github_token: ${{ github.token }}
+          source_ref: 'develop'
+          target_branch: 'master'
+          commit_message_template: '[Automated] Merged {source_ref} into target {target_branch}'
+
+  release:
+    needs: ['update-master-branch']
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch repo
+        uses: actions/checkout@v3
+        with:
+          ref: 'master'
+          fetch-depth: 0
+
+      - name: Install node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Move build out of dist
+        shell: bash
+        run: mv ./dist/mainsail.zip ./mainsail.zip
+
+      - name: Generate a changelog
+        uses: orhun/git-cliff-action@v1
+        id: generate-changelog
+        with:
+          config: ./cliff-release.toml
+          args: -vv --latest --strip header
+        env:
+          output: CHANGES.md
+
+      - name: Create release and upload build
+        uses: softprops/action-gh-release@v1
+        id: create-release
+        with:
+          name: v${{ github.event.inputs.version }}
+          tag_name: v${{ github.event.inputs.version }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: ./mainsail.zip
+          body: ${{ steps.generate-changelog.outputs.content }}
+
+      - name: Copy remote configs to dist
+        shell: bash
+        run: cp ./remote/* ./dist/
+
+      - name: Upload to remote server
+        uses: SamKirkland/FTP-Deploy-Action@4.3.3
+        with:
+          server: ${{ secrets.REMOTEHOST }}
+          username: ${{ secrets.REMOTEUSER }}
+          password: ${{ secrets.REMOTEPASSWORD }}
+          dangerous-clean-slate: true
+          local-dir: ./dist/
+
+  update-changelog:
+    needs: ['release']
+    name: Generate changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: 'develop'
+          token: ${{ secrets.PAT }}
+          fetch-depth: 0
+
+      - name: Get latest tag
+        id: latest_tag
+        shell: bash
+        run: |
+          echo "TAG_NAME=$(git describe --tags $(git rev-list --tags --max-count=1))" >> $GITHUB_OUTPUT
+      - name: Generate a changelog
+        uses: orhun/git-cliff-action@v1
+        id: git-cliff
+        with:
+          config: cliff.toml
+          args: v0.0.4..${{ steps.latest_tag.outputs.TAG_NAME }}
+        env:
+          OUTPUT: ${{ github.workspace }}/CHANGELOG.md
+
+      - name: Show CHANGELOG
+        run: |
+          cat CHANGELOG.md
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: 'chore(changelog): update changelog'
+          file_pattern: CHANGELOG.md

cliff-release.toml

@@ -0,0 +1,66 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# What's Changed
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% for group, commits in commits | group_by(attribute="group") %}\
+    ### {{ group | split(pat="$") | last | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        - **{{commit.scope}}**: {{ commit.message | upper_first | trim }} | [{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }})\
+        {%- if commit.breaking %}
+        {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+        {%- endif -%}
+
+    {%- endfor -%}
+    {%- for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+        {% raw %}\n{% endraw %}\
+        - {{ commit.message | upper_first | trim }} | [{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }})\
+        {%- if commit.breaking %}
+        {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+        {%- endif -%}
+
+        {% endif -%}
+    {% endfor -%}
+    {% raw %}\n{% endraw %}
+{% endfor %}\n\
+"""
+# remove the leading and trailing whitespaces from the template
+trim = true
+# changelog footer
+footer = """
+"""
+
+[git]
+# allow only conventional commits
+# https://www.conventionalcommits.org
+conventional_commits = true
+filter_unconventional = true
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^docs\\(changelog\\):", group = "Changelog", skip = true}, # Old redundant commits
+    { message = "^feat(\\(.*\\))?:", group = "1$Features"},
+    { message = "^feature(\\(.*\\))?:", group = "1$Features"},
+    { message = "^fix(\\(.*\\))?:", group = "2$Bug Fixes and Improvements"},
+    { message = "^docs(\\(.*\\))?:", group = "7$Documentation"},
+    { message = "^perf(\\(.*\\))?:", group = "3$Performance"},
+    { message = "^refactor(\\(.*\\))?:", group = "4$Refactor"},
+    { message = "^style(\\(.*\\))?:", group = "5$Styling"},
+    { message = "^test(\\(.*\\))?:", group = "9$Other"},
+    { message = "^locale(\\(.*\\))?:", group = "6$Localization"},
+    { message = "^chore(\\(.*\\))?:", group = "9$Other"},
+    { body = ".*security", group = "Security"},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = true
+ignore_tags="v*-(beta|rc)*"
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]*"

cliff.toml

@@ -17,15 +17,14 @@ body = """
     ## [unreleased]
 {% endif %}\
 {% for group, commits in commits | group_by(attribute="group") %}\
-    ### {{ group | upper_first }}
+    ### {{ group | split(pat="$") | last | upper_first }}
     {% for commit in commits
     | filter(attribute="scope")
     | sort(attribute="scope") %}
         - **{{commit.scope}}**: {{ commit.message | upper_first | trim }} | [{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }})\
         {%- if commit.breaking %}
         {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
         {%- endif -%}
-
     {%- endfor -%}
     {%- for commit in commits %}
         {%- if commit.scope -%}
@@ -35,7 +34,6 @@ body = """
         {%- if commit.breaking %}
         {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
         {%- endif -%}
-
         {% endif -%}
     {% endfor -%}
     {% raw %}\n{% endraw %}
@@ -55,21 +53,21 @@ filter_unconventional = false
 # regex for parsing and grouping commits
 commit_parsers = [
     { message = "^docs\\(changelog\\):", group = "Changelog", skip = true}, # Old redundant commits
-    { message = "^feat(\\(.*\\))?:", group = "Features"},
-    { message = "^feature(\\(.*\\))?:", group = "Features"},
-    { message = "^fix(\\(.*\\))?:", group = "Bug Fixes"},
-    { message = "^docs(\\(.*\\))?:", group = "Documentation"},
-    { message = "^perf(\\(.*\\))?:", group = "Performance"},
-    { message = "^refactor(\\(.*\\))?:", group = "Refactor"},
-    { message = "^style(\\(.*\\))?:", group = "Styling"},
-    { message = "^test(\\(.*\\))?:", group = "Testing"},
-    { message = "^locale(\\(.*\\))?:", group = "Localization"},
-    { message = "^chore(\\(.*\\))?:", group = "Miscellaneous Tasks", skip = true}, # chore tasks are not relevant for the changelog
+    { message = "^feat(\\(.*\\))?:", group = "1$Features"},
+    { message = "^feature(\\(.*\\))?:", group = "1$Features"},
+    { message = "^fix(\\(.*\\))?:", group = "2$Bug Fixes and Improvements"},
+    { message = "^docs(\\(.*\\))?:", group = "7$Documentation"},
+    { message = "^perf(\\(.*\\))?:", group = "3$Performance"},
+    { message = "^refactor(\\(.*\\))?:", group = "4$Refactor"},
+    { message = "^style(\\(.*\\))?:", group = "5$Styling"},
+    { message = "^test(\\(.*\\))?:", group = "9$Other"},
+    { message = "^locale(\\(.*\\))?:", group = "6$Localization"},
+    { message = "^chore(\\(.*\\))?:", group = "9$Other"},
     { body = ".*security", group = "Security"},
     { message = "release v2.1.2", group = "Release"}, # workaround for v2.1.2 release
 ]
 # filter out the commits that are not matched by commit parsers
 filter_commits = true
 ignore_tags="v*-(beta|rc)*"
 # glob pattern for matching git tags
-tag_pattern = "v[0-9]*"
+tag_pattern = "v[0-9]*"

remote/.htaccess

@@ -0,0 +1,8 @@
+<IfModule mod_rewrite.c>
+  RewriteEngine On
+  RewriteBase /
+  RewriteRule ^index\.html$ - [L]
+  RewriteCond %{REQUEST_FILENAME} !-f
+  RewriteCond %{REQUEST_FILENAME} !-d
+  RewriteRule . /index.html [L]
+</IfModule>

remote/config.json

@@ -0,0 +1,7 @@
+{
+    "defaultLocale": "en",
+    "hostname": null,
+    "port": null,
+    "instancesDB": "browser",
+    "instances": []
+}

src/store/actions.ts

@@ -32,7 +32,6 @@ export const actions: ActionTree<RootState, RootState> = {
     importConfigJson({ commit }, payload: ConfigJson) {
         type RootStateInstancesDbType = 'moonraker' | 'browser' | 'json'
         let instancesDB: RootStateInstancesDbType = payload.instancesDB ?? 'moonraker'
-        if (document.location.hostname === 'my.mainsail.xyz') instancesDB = 'browser'
         if (import.meta.env.VUE_APP_INSTANCES_DB)
             instancesDB = import.meta.env.VUE_APP_INSTANCES_DB as RootStateInstancesDbType