Merge branch 'Acode-Foundation:main' into main

Author: RohitKushvaha01

.github/workflows/community-release-notifier.yml

@@ -1,44 +1,126 @@
 name: community-release-notifier
+
 on:
   release:
     types: [ released ]
   workflow_call:
     inputs:
-       tag_name:
-          required: true
-          description: "Release tag_name"
-          type: 'string' 
-       url: 
-          required: true
-          description: "release URL"
-          type: 'string'
-       body: 
-          required: true
-          description: "Release Body"
-          type: 'string'
-          default: ''
+      tag_name:
+        required: true
+        description: "Release tag_name"
+        type: 'string'
+      url:
+        required: true
+        description: "release URL"
+        type: 'string'
+      body:
+        required: true
+        description: "Release Body"
+        type: 'string'
+        default: ''
     secrets:
       DISCORD_WEBHOOK_RELEASE_NOTES:
         description: 'Discord Webhook for Notifying Releases to Discord'
         required: true
+      TELEGRAM_BOT_TOKEN:
+        description: 'Telegram Bot Token'
+        required: true
+      TELEGRAM_CHAT_ID:
+        description: 'Telegram Chat ID (group/channel/supergroup)'
+        required: true
+      TELEGRAM_MESSAGE_THREAD_ID:
+        description: 'Topic / message_thread_id for Telegram forum/topic'
+        required: true
 
 jobs:
-  discord-release:
+  notify:
     if: github.repository_owner == 'Acode-Foundation'
     runs-on: ubuntu-latest
     steps:
-    - name: Get Release Content
-      id: get-release-content
-      uses: 2428392/gh-truncate-string-action@b3ff790d21cf42af3ca7579146eedb93c8fb0757 # v1.4.1
-      with:
-        maxLength: 2000
-        stringToTruncate: |
-          📢 Acode [${{ github.event.release.tag_name || inputs.tag_name }}](<${{ github.event.release.url || inputs.url }}>) was just Released 🎉!
+      - name: Prepare release variables
+        id: vars
+        env:
+          INPUT_TAG: ${{ github.event.release.tag_name || inputs.tag_name }}
+          INPUT_URL: ${{ github.event.release.url || inputs.url }}
+          INPUT_BODY: ${{ github.event.release.body || inputs.body }}
+        run: |
+          TAG="$INPUT_TAG"
+          URL="$INPUT_URL"
+          
+          # Generate a random delimiter (hex string, safe and collision-resistant)
+          DELIMITER=$(openssl rand -hex 16 || head -c 16 /dev/urandom | xxd -p -c 16)
           
-          ${{ github.event.release.body || inputs.body }}
+          # Escape problematic characters for MarkdownV2 (very conservative escaping)
+          # We escape: _ * [ ] ( ) ~ ` > # + - = | { } . ! \
+          BODY_SAFE=$(printf '%s' "$INPUT_BODY" | \
+            sed 's/[_*[\]()~`>#+=|{}.!\\-]/\\&/g')
+          TAG_SAFE=$(printf '%s' "$TAG" | sed 's/[_*[\]()~`>#+=|{}.!\\-]/\\&/g')
+
+          if [[ "$TAG" == *"-nightly"* ]]; then
+            SUFFIX=" \(Nightly Release\)"
+            SUFFIXPLAIN=" (Nightly Release)"
+          else
+            SUFFIX=""
+            SUFFIXPLAIN=""
+          fi
+
+          # Announcement line — also escape for safety
+          ANNOUNCE_SAFE="📢 Acode [$TAG_SAFE]($URL) was just Released 🎉${SUFFIX}\\!"
+
+          echo "announce=$ANNOUNCE_SAFE" >> $GITHUB_OUTPUT
+          {
+            echo "body_safe<<$DELIMITER"
+            printf '%s\n' "$BODY_SAFE"
+            echo "$DELIMITER"
+          } >> $GITHUB_OUTPUT
+
+          # Plain (MD) Announcement for Discord
+          ANNOUNCE_PLAIN="📢 Acode [$TAG](<$URL>) was just Released 🎉${SUFFIXPLAIN}!"
+          echo "announce_plain=$ANNOUNCE_PLAIN" >> $GITHUB_OUTPUT
+          {
+            echo "body_plain<<$DELIMITER"
+            printf '%s\n' "$INPUT_BODY"
+            echo "$DELIMITER"
+          } >> $GITHUB_OUTPUT
+
+      # ────────────────────────────────────────────────
+      # Truncate for Discord
+      # ────────────────────────────────────────────────
+      - name: Truncate message for Discord
+        id: truncate-discord
+        uses: 2428392/gh-truncate-string-action@b3ff790d21cf42af3ca7579146eedb93c8fb0757  # v1.4.1
+        with:
+          maxLength: 2000
+          stringToTruncate: |
+            ${{ steps.vars.outputs.announce_plain }}
+
+            ${{ steps.vars.outputs.body_plain }}
+
+      # ────────────────────────────────────────────────
+      # Discord notification
+      # ────────────────────────────────────────────────
+      - name: Discord Webhook (Publishing)
+        uses: tsickert/discord-webhook@b217a69502f52803de774ded2b1ab7c282e99645  # v7.0.0
+        with:
+          webhook-url: ${{ secrets.DISCORD_WEBHOOK_RELEASE_NOTES }}
+          content: ${{ steps.truncate-discord.outputs.string }}
+          flags: 4 # 1 << 2 - SUPPRESS_EMBEDS!
+
+      # ────────────────────────────────────────────────
+      # Telegram notification — MarkdownV2 + no link preview
+      # ────────────────────────────────────────────────
+      - name: Send to Telegram
+        #if: ${{ secrets.TELEGRAM_BOT_TOKEN != '' && secrets.TELEGRAM_CHAT_ID != '' && secrets.TELEGRAM_MESSAGE_THREAD_ID != '' }}
+        uses: Salmansha08/telegram-github-action@17c9ce6b4210d2659dca29d34028b02fa29d70ad  # or newer tag if available
+        with:
+          to: ${{ secrets.TELEGRAM_CHAT_ID }}
+          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
+          message: |
+            ${{ steps.vars.outputs.announce }}
 
-    - name: Discord Webhook Action (Publishing)
-      uses: tsickert/discord-webhook@c840d45a03a323fbc3f7507ac7769dbd91bfb164 # v5.3.0
-      with:
-        webhook-url: ${{ secrets.DISCORD_WEBHOOK_RELEASE_NOTES }}
-        content: ${{ steps.get-release-content.outputs.string }}
+            ${{ steps.vars.outputs.body_safe }}
+          format: markdown
+          disable_web_page_preview: true
+          # Only needed for topic-enabled supergroups/channels
+          message_thread_id: ${{ secrets.TELEGRAM_MESSAGE_THREAD_ID }}
+        continue-on-error: true

.github/workflows/nightly-build.yml

@@ -95,24 +95,25 @@
             echo "should not skip tags, releases: ${{ ! inputs.skip_tagging_and_releases }}" >> $GITHUB_STEP_SUMMARY     
 
         - name: Checkout Repository
-          uses: actions/checkout@v4
+          uses: actions/checkout@v6
           with:
             fetch-depth: 0 # Required for tags
             # persists credentials locally if tagging and releases are not skipped.
             persist-credentials: ${{ ! inputs.skip_tagging_and_releases }}
             ref: ${{ (inputs.is_PR && inputs.PR_NUMBER) && github.event.pull_request.head.sha || '' }}
 
         - name: Set up Java 21
-          uses: actions/setup-java@v4
+          uses: actions/setup-java@v5
           with:
             distribution: 'temurin'
             java-version: '21'
             cache: ${{ (!(inputs.is_PR && inputs.PR_NUMBER) && github.ref == 'refs/heads/main' && 'gradle') || '' }}
 
         - name: Set up Node.js
-          uses: actions/setup-node@v4
+          uses: actions/setup-node@v6
           with:
             node-version: 'lts/*' # or '18.x' for latest stable
+            cache: ${{ (!(inputs.is_PR && inputs.PR_NUMBER) && github.ref == 'refs/heads/main' && 'npm') || '' }}
 
         - name: Add keystore and build.json from secrets
           run: |
@@ -175,7 +176,7 @@
              echo "VERSION: $UPDATED_VERSION" >> $GITHUB_STEP_SUMMARY
              
         - name: Upload APK Artifact
-          uses: actions/upload-artifact@v4
+          uses: actions/upload-artifact@v6
           with:
             name: app-debug-${{ env.GIT_COMMIT }}
             path: /tmp/app-debug-normal.apk
@@ -188,7 +189,7 @@
             mv platforms/android/app/build/outputs/apk/debug/app-debug.apk /tmp/app-debug-fdroid.apk
         
         - name: Upload APK Artifact
-          uses: actions/upload-artifact@v4
+          uses: actions/upload-artifact@v6
           if: ${{ !inputs.is_PR }}
           with:
             name: app-debug-fdroid-${{ env.GIT_COMMIT }}
@@ -283,3 +284,6 @@
          body: ${{ needs.build.outputs.RELEASE_NOTES }}
       secrets:
         DISCORD_WEBHOOK_RELEASE_NOTES: ${{ secrets.DISCORD_WEBHOOK_RELEASE_NOTES }}
+        TELEGRAM_BOT_TOKEN: ${{ secrets.TELEGRAM_BOT_TOKEN }}
+        TELEGRAM_CHAT_ID: ${{ secrets.TELEGRAM_CHAT_ID }}
+        TELEGRAM_MESSAGE_THREAD_ID: ${{ secrets.TELEGRAM_MESSAGE_THREAD_ID }}

.github/workflows/on-demand-preview-releases-PR.yml

@@ -34,7 +34,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           clean: false
           fetch-depth: 0

CONTRIBUTING.md

@@ -166,6 +166,45 @@ refactor: simplify file loading logic
    pnpm run lang update    # Update translations
    ```
 
+## ℹ️ Adding New Icons (to the existing font family)
+> [!NOTE]
+> Acode uses SVG and converts them into a font family, to be used inside the editor and generally for plugin devs.
+> 
+> **Plugin-specific icons SHOULD NOT be added into the editor. Only generally helpful icons SHOULD BE added**
+
+Many font editing software and web-based tools exist for this purpose. Some of them are listed below.
+
+| Name | Platform |
+|------|----------|
+| https://icomoon.io/ | Free (Web-Based, PWA-supported, Offline-supported) |
+| https://fontforge.org/ | Open-Source (Linux, Mac, Windows) |
+
+### Steps in Icomoon to add new Icons
+
+1. Download the `icons.ttf` file from https://github.com/Acode-Foundation/Acode/tree/main/src/res/icons
+2. Go to https://icomoon.io/ > Start a new Project
+3. Import the `icons.ttf` downloaded (in step 1)
+4. All icons will be displayed after importing.
+5. Import the SVG icon created/downloaded to be added to the Font Family.
+6. On the right side, press **enable Show Characters** to view the Unicode character for that icon.
+7. Copy the newly added icon's Unicode character (required for later steps)
+8. Repeat Step 5 and Step 7 until all needed new icons are added.
+9. Press the export icon from the top left-hand side.
+10. Add **Font** in the formats section, expand the **Font**, enter **code-editor-icon** as the font-family for `icons.ttf` file.
+11. Press the download button, and a zip file will be downloaded.
+
+### Adding the Unicode characters to style.css
+
+1. Open the `style.css` file present at https://github.com/Acode-Foundation/Acode/tree/main/src/res/icons
+2. Add a new class called `.icon.icon-name:before` e.g ```.icon.all_inclusive:before { content: "\ea18"; }```
+3. `content` (i.e., `ea18` -> `\ea18`) property's value is the Unicode Character copied after importing the icon in the font family.
+4. Save the `style.css` file.
+5. Extract the downloaded zip file; navigate to the `fonts` folder inside it.
+6. Rename `code-editor-icon.ttf` to `icons.ttf`.
+7. Copy & paste the renamed `icons.ttf` into https://github.com/Acode-Foundation/Acode/tree/main/src/res/icons
+8. Commit the changes **ON A NEW branch** (by following: [Commit Messages guide](#commit-messages))
+5. commit the changes **ON A NEW branch** (by following: [Commit Messages guide](#commit-messages))
+
 ## 🔌 Plugin Development
 
 To create plugins for Acode: