Merge pull request #19 from Roblox-Indie-Wikis/development

Release version 1.2.0

Author: SomeMWDev

.github/workflows/ci.yml

@@ -20,6 +20,9 @@ jobs:
           - mw: 'REL1_42'
             php: 8.1
             experimental: false
+          - mw: 'REL1_43'
+            php: 8.1
+            experimental: false
           - mw: 'master'
             php: 8.1
             experimental: true

CONTRIBUTING.md

@@ -1,5 +1,30 @@
 # Contributing
 
+- [Contributing](#contributing)
+    * [Requesting a new data source](#requesting-a-new-data-source)
+        + [Requirements](#requirements)
+    * [Developing on the RobloxAPI extension](#developing-on-the-robloxapi-extension)
+        + [Installing dependencies](#installing-dependencies)
+        + [Running tests](#running-tests)
+            - [PHP unit tests](#php-unit-tests)
+            - [Parser tests](#parser-tests)
+            - [JavaScript tests](#javascript-tests)
+        + [Code Style](#code-style)
+    * [Releasing a new version](#releasing-a-new-version)
+
+## Requesting a new data source
+
+If you would like to request a new data source, please open an issue on the GitHub repository. Please use the
+*Roblox API endpoint request* template.
+
+### Requirements
+
+A data source must fulfill the following requirements:
+
+* It must be accessible without authentication
+* It must be an official endpoint provided by Roblox
+* It must not require multiple requests to be made (if this is required, consider requesting two separate data sources)
+
 ## Developing on the RobloxAPI extension
 
 ### Installing dependencies
@@ -38,3 +63,15 @@ Running `npm test`will run automated code checks.
 The PHP part of this project follows
 the [MediaWiki coding conventions](https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP). The code formatting is
 enforced by the CI pipeline which runs phan before a PR can be merged.
+
+## Releasing a new version
+
+This guide is only for maintainers of the extension.
+
+1. Update the version number in `extension.json`
+2. Update the documentation if there were any relevant changes
+3. Merge development into master
+4. Create a new release on GitHub
+5. Close milestone (if applicable)
+6. Create a branch from master with the version number as the branch name, e.g. `ver/1.1.0`
+7. Update the documentation on mediawiki.org if there were any relevant changes

README.md

@@ -2,28 +2,35 @@
 
 A MediaWiki extension which provides easy access to the Roblox API via parser functions. The Roblox API is generally
 very poorly documented, and using ExternalData or Lua can be hard or not viable for all wiki users. This extension aims
-to make it easy for you to grab data from Roblox and put it on your wiki. Formerly developed by [Dovedale Wiki](https://github.com/dovedalewiki). 
+to make it easy for you to grab data from Roblox and put it on your wiki. Formerly developed
+by [Dovedale Wiki](https://github.com/dovedalewiki).
 
 > [!NOTE]
-> This extension is still in development.
+> In version 1.2.0, major changes have been made to the extension. The new `{{#robloxAPI}}` parser function provides new
+> features and should now be the only one used to access the Roblox API. While the old parser functions remain working
+> as before, they might be removed in a future version.
+>
+> Please see the [USAGE.md](USAGE.md#Migrating-from-the-old-parser-functions) file for the latest documentation on how
+> to use the extension.
 
-Live Examples: 
-https://dovedale.wiki 
-https://hybridcafe.wiki
-https://utg.miraheze.org 
+Live Examples:
+
+* [Dovedale Wiki](https://dovedale.wiki/)
+* [Hybrid Cafe Wiki](https://hybridcafe.wiki/)
+* [UTG Wiki](https://utg.miraheze.org/)
 
 ## Installation
 
 1. Download the repository using the following
    link: [Download ZIP](https://github.com/Roblox-Indie-Wikis/mediawiki-extensions-RobloxAPI/archive/master.zip)
 2. Place the files in a directory called `RobloxAPI` in your `extensions/` folder.
-2. Add the following line to the end of your `LocalSettings.php` file:
+3. Add the following line to the end of your `LocalSettings.php` file:
     ```php
     wfLoadExtension( 'RobloxAPI' );
     ```
 
-Miraheze users may use ManageWiki to install this extension. Search for 'RobloxAPI' in [[Special:ManageWiki]] and install it with a
-click.
+Miraheze users may use ManageWiki to install this extension. Search for 'RobloxAPI' in *Special:ManageWiki* and
+install it with a click.
 
 ## Usage
 

RobloxAPI.i18n.magic.php

@@ -20,13 +20,14 @@
 
 $magicWords = [];
 $magicWords['en'] = [
-	'roblox_grouprank' => [ 0, 'rblxGroupRank' ],
-	'roblox_activeplayers' => [ 0, 'rblxPlaceActivePlayers' ],
-	'roblox_visits' => [ 0, 'rblxPlaceVisits' ],
-	'roblox_groupmembers' => [ 0, 'rblxGroupMembers' ],
-	'roblox_useravatarthumbnailurl' => [ 0, 'rblxUserAvatarThumbnailUrl' ],
-	'roblox_userid' => [ 0, 'rblxUserId' ],
-	// data source parser functions
+	'robloxapi' => [ 0, 'robloxAPI' ],
+	// DEPRECATED - all of these parser functions are replaced by #robloxAPI and might be removed in the future
+	'roblox_GroupRank' => [ 0, 'rblxGroupRank' ],
+	'roblox_ActivePlayers' => [ 0, 'rblxPlaceActivePlayers' ],
+	'roblox_Visits' => [ 0, 'rblxPlaceVisits' ],
+	'roblox_GroupMembers' => [ 0, 'rblxGroupMembers' ],
+	'roblox_UserAvatarThumbnailUrl' => [ 0, 'rblxUserAvatarThumbnailUrl' ],
+	'roblox_UserId' => [ 0, 'rblxUserId' ],
 	'roblox_GameData' => [ 0, 'rblxGameData' ],
 	'roblox_GroupRoles' => [ 0, 'rblxGroupRoles' ],
 	'roblox_GroupData' => [ 0, 'rblxGroupData' ],

SECURITY.md

@@ -2,9 +2,10 @@
 
 ## Reporting a Vulnerability
 
-To report a vulnerability, it is strongly adviced to file a security advisory on GitHub:
-https://github.com/Roblox-Indie-Wikis/mediawiki-extensions-RobloxAPI/security/advisories/new
+To report a vulnerability, it is strongly advised to file a security advisory on GitHub:
+[Report a security advisory](https://github.com/Roblox-Indie-Wikis/mediawiki-extensions-RobloxAPI/security/advisories/new)
 
 If you do not want to use GitHub for this, please contact the main maintainer of this repository at
+
 - thisisnotmyname275@gmail.com (E-Mail)
 - @abaddriverlol (Discord)