Push latest wiki changes into production

.github/workflows/book_deploy.yml

@@ -8,79 +8,95 @@ on:
 
 jobs:
   build:
-    name: Build wiki book
+    name: Build wiki
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-    - name: Install mdbook
-      uses: MineBartekSA/quick-mdbook@v1.1
-    - name: Build book
-      env:
-        SCRIPT: https://gist.githubusercontent.com/MineBartekSA/5234f09c1048f9ba007d0a26a8fd654e/raw/github-release.sh
-        DISCORD_TOKEN: ${{ secrets.DISCORD_TOKEN }}
-      run: |
-        curl -fsSL $SCRIPT | bash -s -- NilPointer-Software/mdbook-discord-components
-        tar xzf mdbook-discord-components-*.tar.gz
-        mdbook build
-    - name: Upload book
-      uses: actions/upload-artifact@v3
-      with:
-        name: book
-        path: book
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |-
+          gh release download -R rust-lang/mdBook -p mdbook-*-x86_64-unknown-linux-gnu.tar.gz
+          gh release download -R tommilligan/mdbook-admonish -p mdbook-admonish-*-x86_64-unknown-linux-gnu.tar.gz
+          gh release download -R NilPointer-Software/mdbook-discord-components -p mdbook-discord-components-*.tar.gz
+
+          for file in *.tar.gz
+            do tar xzf "$file" -C /usr/local/bin
+            rm $file
+          done
+
+      - name: Build book
+        env:
+          DISCORD_TOKEN: ${{ secrets.DISCORD_TOKEN }}
+        run: |-
+          mdbook-admonish install --css-dir src/theme
+          mdbook build
+
+      - name: Upload book
+        uses: actions/upload-artifact@v4
+        with:
+          name: book
+          path: book
 
   deploy-prod:
     name: Deploy production wiki
     needs: build
-    if: github.ref == 'refs/heads/prod'
+    if: github.ref_name == 'prod'
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-      with:
-        ref: gh-pages
-    - name: Prepare to fetch book
-      run: |
-        mv nightly ..
-        rm -rf *
-    - name: Fetch book artifact
-      uses: actions/download-artifact@v3
-      with:
-        name: book
-    - name: Deploy
-      run: |
-        mv ../nightly .
-        git config user.name "Github Actions"
-        git config user.email ""
-        git add .
-        git commit -m "Deploy $GITHUB_SHA to gh-pages"
-        git push --force --set-upstream origin gh-pages
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+
+      - name: Prepare to fetch book
+        run: |-
+          mv nightly ..
+          rm -rf *
+
+      - name: Fetch book artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: book
+
+      - name: Deploy
+        run: |-
+          mv ../nightly .
+          git add -A
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git commit -m "Deploy $GITHUB_SHA to gh-pages"
+          git push --force --set-upstream origin gh-pages
 
   deploy-nightly:
     name: Deploy nightly wiki
     needs: build
-    if: github.ref == 'refs/heads/dev'
+    if: github.ref_name == 'dev'
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-      with:
-        ref: gh-pages
-    - name: Prepare to fetch book
-      run: |
-        rm -rf nightly/*
-    - name: Fetch book artifact
-      uses: actions/download-artifact@v3
-      with:
-        name: book
-        path: nightly
-    - name: Deploy
-      run: |
-        git config user.name "Github Actions"
-        git config user.email ""
-        git add .
-        git commit -m "Deploy nightly $GITHUB_SHA to gh-pages"
-        git push --force --set-upstream origin gh-pages
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+
+      - name: Prepare to fetch book
+        run: rm -rf nightly/*
+
+      - name: Fetch book artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: book
+          path: nightly
+
+      - name: Deploy
+        run: |-
+          git add -A
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git commit -m "Deploy nightly $GITHUB_SHA to gh-pages"
+          git push --force --set-upstream origin gh-pages
 
   notify-discord:
     name: Send notification
@@ -91,46 +107,47 @@ jobs:
       TYPE: Nightly
       LINK: nightly
     steps:
-    - name: Prepare notification
-      env:
-        RAW: ${{ github.event.head_commit.message }}
-      run: |
-        echo "MESSAGE<<EOF" >> $GITHUB_ENV
-        RAW=$(echo "$RAW" | sed -r '/^\s*$/d')
-        echo "$RAW" | head -n 10 | sed ':a;N;$!ba;s/\n/\n  /g' >> $GITHUB_ENV
-        if [ $(echo "$RAW" | wc -l) -gt 10 ]
-        then
-          echo "  ..." >> $GITHUB_ENV
-        fi
-        echo "EOF" >> $GITHUB_ENV
-    - name: Set notification type
-      if: github.ref == 'refs/heads/prod'
-      run: |
-        echo "TYPE=Production" >> $GITHUB_ENV
-        echo "LINK=" >> $GITHUB_ENV
-    - name: Send wiki update notification
-      uses: MineBartekSA/discord-webhook@v2.1
-      with:
-        webhook: ${{ secrets.WEBHOOK }}
-        embed: |
-          title: "${{ env.TYPE }} Wiki Update"
-          color: 10001644
-          author:
-            name: ${{ github.event.head_commit.author.username }}
-            url: https://github.com/${{ github.event.head_commit.author.username }}
-            icon_url: https://github.com/${{ github.event.head_commit.author.username }}.png
-          thumbnail:
-            url: https://botdesignerdiscord.com/logo512.png
-          description: |
-            **__Content__**
-
-            ${{ env.MESSAGE }}
-        component: |
-          - type: 2
-            style: 5
-            label: Jump to commit
-            url: ${{ github.event.head_commit.url }}
-          - type: 2
-            style: 5
-            label: Jump to ${{ env.TYPE }} Wiki
-            url: https://nilpointer-software.github.io/bdfd-wiki/${{ env.LINK }}
+      - name: Prepare notification
+        env:
+          RAW: ${{ github.event.head_commit.message }}
+        run: |-
+          echo "MESSAGE<<EOF" >> $GITHUB_ENV
+          RAW=$(echo "$RAW" | sed -r '/^\s*$/d')
+          echo "$RAW" | head -n 10 | sed ':a;N;$!ba;s/\n/\n  /g' >> $GITHUB_ENV
+          if [ $(echo "$RAW" | wc -l) -gt 10 ]; then
+            echo "  ..." >> $GITHUB_ENV
+          fi
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: Set notification type
+        if: github.ref_name == 'prod'
+        run: |-
+          echo "TYPE=Production" >> $GITHUB_ENV
+          echo "LINK=" >> $GITHUB_ENV
+
+      - name: Send notification
+        uses: MineBartekSA/discord-webhook@v2.1
+        with:
+          webhook: ${{ secrets.WEBHOOK }}
+          embed: |-
+            title: "${{ env.TYPE }} Wiki Update"
+            color: 10001644
+            author:
+              name: ${{ github.event.head_commit.author.username }}
+              url: https://github.com/${{ github.event.head_commit.author.username }}
+              icon_url: https://github.com/${{ github.event.head_commit.author.username }}.png
+            thumbnail:
+              url: https://botdesignerdiscord.com/logo512.png
+            description: |-
+              **__Content__**
+
+              ${{ env.MESSAGE }}
+          component: |-
+            - type: 2
+              style: 5
+              label: View commit
+              url: ${{ github.event.head_commit.url }}
+            - type: 2
+              style: 5
+              label: Preview site
+              url: https://nilpointer-software.github.io/bdfd-wiki/${{ env.LINK }}

book.toml

@@ -1,50 +1,50 @@
 [book]
+title = "Bot Designer For Discord - Wiki"
 authors = ["NilPointer Software"]
-language = "en"
-multilingual = false
-src = "src"
-title = "Bot Designer for Discord - Wiki"
-description = "A wiki page which explains BDFD functions, callbacks, features & much more."
+description = "The official documentation of BDFD. It covers guides, examples related to BDScript, BDJS and as well features too."
 
-[preprocessor.mdbook-discord-components]
-after = ["links"]
-command = "./mdbook-discord-components"
-embed-script = false
+[build]
+create-missing = false
 
 [output.html]
 theme = "src/theme"
 default-theme = "bdfd"
 preferred-dark-theme = "bdfd"
+smart-punctuation = true
 git-repository-url = "https://github.com/NilPointer-Software/bdfd-wiki"
-input-404 = "./404.md"
-site-url = "/bdfd-wiki/"
 edit-url-template = "https://github.com/NilPointer-Software/bdfd-wiki/edit/dev/{path}"
+site-url = "/bdfd-wiki/"
+
+[output.html.fold]
+enable = true
+
+[output.html.code]
+hidelines = { bdscript = "{$hide}" }
 
 [output.html.search]
 boost-title = 4  
 
-[output.html.fold]
-enable = true
-level = 0
+[preprocessor.mdbook-discord-components]
+after = ["links"]
+command = "mdbook-discord-components"
+embed-script = false
+
+[preprocessor.admonish]
+on_failure = "bail"
 
+# Redirects old wiki URL paths used by the app to new ones.
+# TODO: Remove URLs when old paths gets updated in the app.
 [output.html.redirect]
-#(categories that still use the old /guides path, remove if the path is updated to the new one in app)
-#if statements
 "/guides/ifStatements.html" = "./general/ifStatements.html"
-#async 
 "/guides/async.html" = "./general/bds2/asyncScopes.html"
-#buttons
 "/guides/buttons.html" = "./general/interactions/buttons/aboutButtons.html"
-#select menu (based on my archived guides, the old path for errorHandling and selectMenus aren't in camelCase. ~Carmen)
 "/selectmenu.html" = "./guides/general/interactions/selectMenus/aboutSelectMenu.html"
-#error handling
 "/trycatch.html" = "./guides/general/bds2/errorHandling.html"
-#premium functions
+
 "/bdscript/awaitReactions.html" = "../premium/awaitReactions.html"
 "/bdscript/customImage.html" = "../premium/customImage.html"
 "/bdscript/ignoreTriggerCase.html" = "../premium/ignoreTriggerCase.html"
-#(categories that redirects to /bdscript in the app instead of /guides)
-#http requests
+
 "/bdscript/httpAddHeader.html" = "../guides/general/httpRequests.html"
 "/bdscript/httpDelete.html" = "../guides/general/httpRequests.html"
 "/bdscript/httpGet.html" = "../guides/general/httpRequests.html"
@@ -56,7 +56,7 @@ level = 0
 "/bdscript/httpResult.html" = "../guides/general/httpRequests.html"
 "/bdscript/httpResultComplex.html" = "../guides/general/httpRequests.html"
 "/bdscript/httpStatus.html" = "../guides/general/httpRequests.html"
-#json functions
+
 "/bdscript/json.html" = "../guides/general/jsonFunctions.html#json"
 "/bdscript/jsonArray.html" = "../guides/general/jsonFunctions.html#jsonarray"
 "/bdscript/jsonArrayAppend.html" = "../guides/general/jsonFunctions.html#jsonarrayappend"
@@ -76,7 +76,7 @@ level = 0
 "/bdscript/jsonSetString.html" = "../guides/general/jsonFunctions.html#jsonsetstring"
 "/bdscript/jsonStringify.html" = "../guides/general/jsonFunctions.html#jsonstringify"
 "/bdscript/jsonUnset.html" = "../guides/general/jsonFunctions.html#jsonunset"
-#webhooks
+
 "/bdscript/webhookAvatarURL.html" = "../guides/general/webhooks.html"
 "/bdscript/webhookColor.html" = "../guides/general/webhooks.html"
 "/bdscript/webhookContent.html" = "../guides/general/webhooks.html"

external/CHANGELOG.json

@@ -1,4 +1,19 @@
 {
+    "2024": {
+        "july": [
+            "Added `$isBooster[]`",
+            "Added `$setUserRoles[]`",
+            "Added `$getLeaderboardPosition[]`"
+        ],
+        "june": [
+            "Added `$ai[]`",
+            "Added `$aiQuota`"
+        ],
+        "march": [
+            "Fixed the bot sometimes duplicating its answer",
+            "Fixed `$onlyForIDs[]` not working correctly on big nodes"
+        ]
+    },
     "2023": {
         "june": [
             "Fixed custom images not always being displayed",

src/CHANGELOG.md

@@ -2,18 +2,23 @@
 
 # 2024
 
+## July
+- Added `$setUserRoles[]`
+- Added `$getLeaderboardPosition[]`
+- Added `$isBooster[]`
+
+<details><summary>Previous Updates</summary>
+
 ## June
 - Added `$ai[]`
 - Added `$aiQuota`
 
-<details><summary>Previous Updates</summary>
-
 ## March
-- Fixed that sometimes the bot duplicates its answer
-- Fixed `$onlyForIDs[]` did not work correctly on big nodes
+- Fixed the bot sometimes duplicating its answer
+- Fixed `$onlyForIDs[]` not working correctly on big nodes
 
 </details>
-   
+
 # 2023
 
 ## June