Merge pull request #543 from FWDekker/update-mds

Update docs, prepare for v3.3.2

.github/CONTRIBUTING.md

@@ -1,8 +1,8 @@
 # Contribution guidelines
 Thank you for considering contributing!
+[All contributions of any size are much appreciated!](https://github.com/FWDekker/intellij-randomness#-acknowledgements)
 
-You can contribute in many ways, whether it's submitting an issue, opening a pull request, or leaving a comment
-somewhere.
+You can contribute in many ways, whether it's submitting an issue, opening a pull request, or leaving a comment somewhere.
 This page provides some guidelines on contributing to Randomness.
 
 
@@ -16,10 +16,16 @@ Several templates are provided to help you structure your issue.
 
 
 ## 🔨 Submit a pull request
-Whether you're adding a new feature, fixing a bug, or fixing a typo in documentation, the following guidelines will help
-you on your way to submitting a good pull request.
+Whether you're adding a new feature, fixing a bug, or fixing a typo in documentation, the following guidelines will help you on your way to submitting a good pull request.
 Pull requests that do not meet the following guidelines are **fine**; these are just guidelines after all.
 
+### 🗃️ Coding conventions
+This project maintains the [Kotlin coding conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
+[Detekt](https://github.com/arturbosch/detekt/) will, amongst others, check these coding conventions.
+Check the [README](../README.md) for instructions on using tools such as Detekt.
+
+Additionally, please make sure you write [good commit messages](https://chris.beams.io/posts/git-commit/).
+
 ### 📚 Documentation
 Always update related documentation, both code documentation and user instructions such as the [README](../README.md).
 Additionally, make sure you update the [change notes](../CHANGELOG.md) if necessary.
@@ -30,14 +36,7 @@ If you need help writing tests you can open a pull request with your work in pro
 
 Always run tests and static analysis before opening a pull request.
 
-### 🗃️ Coding conventions
-This project maintains the [Kotlin coding conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
-[Detekt](https://github.com/arturbosch/detekt/) will, amongst others, check these coding conventions.
-Check the [README](../README.md) for instructions on using tools such as Detekt.
-
-Additionally, please make sure you write [good commit messages](https://chris.beams.io/posts/git-commit/).
-
 
-## 🗞️ Publishing a release
+## 🗞️ Publish a release
 When it's time for a new release, check the [release checklist](RELEASE_CHECKLIST.md) to make sure everything is in
 order.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,10 +24,9 @@ assignees: FWDekker
 <!-- If applicable, add screenshots to help explain your problem. -->
 
 **Version information**
- - Randomness version [e.g. 3.3.1]: <!-- Check `Settings -> Plugins` in your IDE and search for `Randomness` -->
- - IDE version [e.g. IntelliJ Community 2023.3.3]: <!-- Check `Help -> About` in your IDE -->
- - Operating system [e.g. Windows 11, Ubuntu 22.04.3, macOS 14.2.1]: <!-- Use a search engine for help if you don't know -->
- - Java version [e.g. 17.0.9, 21.0.1]: <!-- Run `java -version` in a terminal or check https://www.java.com/en/download/help/version_manual.xml -->
+ - Randomness version [e.g. 3.3.2]: <!-- Check `Settings -> Plugins` in your IDE and search for `Randomness` -->
+ - IDE version [e.g. IntelliJ Community 2024.2.3]: <!-- Check `Help -> About` in your IDE -->
+ - Operating system [e.g. Windows 11, Ubuntu 24.04.1, macOS 15.0]: <!-- Use a search engine for help if you don't know -->
 
 **Additional context**
 <!-- Add any other context about the problem here. -->

.github/RELEASE_CHECKLIST.md

@@ -1,8 +1,7 @@
 # Release checklist
 ## Documentation
 * Bump the version number according to [Semantic Versioning](https://semver.org/).
-* Update [`README.md`](../README.md), [`CHANGELOG.md`](../CHANGELOG.md), and
-  [`description.html`](../src/main/resources/META-INF/description.html) if necessary.
+* Update [`README.md`](../README.md), [`CHANGELOG.md`](../CHANGELOG.md), and [`description.html`](../src/main/resources/META-INF/description.html) if necessary.
     * Make sure to preview the change notes in the IDE by loading the plugin.
     * Make sure that even subsections with a single item use bullet points, otherwise the entry will not show in the IDE.
     * Make sure the list of acknowledgements is up-to-date.
@@ -11,8 +10,7 @@
     * Use the project in `src/test/resources/screenshots/` to store code snippets in.
       Do not store `.idea/`, `.gradle`, and similar build files in this project.
     * Hide (inlay) hints and set font size to 20.
-    * Distance between bottom of "Refresh" button and top of button bar at bottom is 50 pixels, or the original
-      distance, whichever is smaller.
+    * Distance between bottom of "Refresh" button and top of button bar at bottom is 50 pixels, or the original distance, whichever is smaller.
     * On Linux, the screen can be recorded using [peek](https://github.com/phw/peek) or
       [SimpleScreenRecorder](https://www.maartenbaert.be/simplescreenrecorder/).
     * Reducing GIF size is a difficult process.
@@ -24,7 +22,8 @@
          2. "Optimize Transparency" with 2% fuzz
          3. "Lossy GIF" with compression level 30
 * Ensure documentation generates without errors.
-  After the release, run the `cd.yml` workflow to update the `gh-pages` branch.
+  After the release, the [`cd.yml` workflow](https://github.com/FWDekker/intellij-randomness/actions/workflows/cd.yml) should automatically update the `gh-pages` branch.
+  Check that the build action does not fail!
 
 ## Verification
 * Run tests and static analysis one more time.

.github/SECURITY.md

@@ -1,19 +1,14 @@
 # Security policy
 The security of Randomness is important to me.
-If you find a vulnerability in Randomness, please
-[report the vulnerability](https://github.com/FWDekker/intellij-randomness/security/advisories/new) as soon as possible.
+If you find a vulnerability in Randomness, please [report the vulnerability](https://github.com/FWDekker/intellij-randomness/security/advisories/new) as soon as possible.
 
 Please note that Randomness is distinct from IntelliJ and other IDEs developed by JetBrains.
-To report a vulnerability in IntelliJ or another JetBrains product, please
-[check JetBrains' security policy](https://www.jetbrains.com/privacy-security/).
+To report a vulnerability in IntelliJ or another JetBrains product, please [check JetBrains' security policy](https://www.jetbrains.com/privacy-security/).
 
 ## Supported versions
-Only the [latest version of Randomness](https://github.com/FWDekker/intellij-randomness/releases/latest) is ever
-supported and supplied with security patches.
+Only the [latest version of Randomness](https://github.com/FWDekker/intellij-randomness/releases/latest) is ever supported and supplied with security patches.
 
 ## Reporting a vulnerability
-To report a vulnerability in Randomness, please use
-[GitHub's vulnerability reporting feature](https://github.com/FWDekker/mommy/security/advisories/new).
+To report a vulnerability in Randomness, please use [GitHub's vulnerability reporting feature](https://github.com/FWDekker/intellij-randomness/security/advisories/new).
 You will be contacted as soon as possible.
-You will be thanked publicly for reporting the vulnerability, unless you indicate that you prefer to be thanked
-anonymously.
+You will be thanked publicly for reporting the vulnerability, unless you indicate that you prefer to be thanked anonymously.

.github/workflows/cd.yml

@@ -20,7 +20,9 @@ jobs:
         with:
           ref: gh-pages
           path: gh-pages
-          # Required to push updated documentation to repository
+          # Required to push updated documentation to repository.
+          # If you get "Error: fatal: could not read Username for 'https://github.com': terminal prompts disabled", then
+          # the token has probably expired.
           token: ${{ secrets.personal_access_token }}
 
       - name: Set up Java
@@ -29,9 +31,9 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
       - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v3
+        uses: gradle/actions/setup-gradle@v4
+        working-directory: main/
         with:
-          build-root-directory: main/
           add-job-summary: on-failure
 
       - name: Extract version number

.github/workflows/ci.yml

@@ -3,11 +3,13 @@ name: CI
 on:
   push:
     paths-ignore:
+      - 'CHANGELOG.md'
       - 'README.md'
       - '.github/**.md'
       - '.github/img/**'
   pull_request:
     paths-ignore:
+      - 'CHANGELOG.md'
       - 'README.md'
       - '.github/**.md'
       - '.github/img/**'
@@ -46,7 +48,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
       - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v3
+        uses: gradle/actions/setup-gradle@v4
         with:
           add-job-summary: on-failure
       - name: Run tests
@@ -63,7 +65,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
       - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v3
+        uses: gradle/actions/setup-gradle@v4
         with:
           add-job-summary: on-failure
       - name: Run tests

CHANGELOG.md

@@ -1,10 +1,11 @@
 # Changelog
-## [9.9.9-unreleased]
+## 3.3.2 -- 2024-09-28
 ### Added
 * Added even more debug info for future reports relating to issue [#R1](https://github.com/FWDekkerBot/intellij-randomness-issues/issues/1).
 
 ### Changed
 * Changed icon instantiation to be more in line with guidelines, hopefully fixing [#R13](https://github.com/FWDekkerBot/intellij-randomness-issues/issues/13).
+* Updated various dependencies, especially those related to tooling.
 
 
 ## 3.3.1 -- 2024-05-06