Merge pull request #634 from refinedmods/release/2.0.0-milestone.4.5

Release v2.0.0-milestone.4.5

.git-blame-ignore-revs

@@ -2,3 +2,5 @@
 
 # Rename "refinedstorage2" to "refinedstorage"
 03d02f1e07e1e6e9726404c236c3af227126ade0
+# Remove "platform" prefix from modules
+328e1bfeb40342a81c375da4a5f75c9a36fe8ef8

.github/CONTRIBUTING.md

@@ -12,6 +12,7 @@ These are the most important things to know before contributing (also explained
 - Branch names must be formatted correctly. The format is `{category}/GH-{issue number}/{lowercase-description}`.
   Category must match a
   category [used in our Commitlint config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum).
+  You can also use `NO-ISSUE` instead of a GitHub issue number.
 - We use [Checkstyle](https://checkstyle.sourceforge.io/) in our build workflow to validate coding style. It is
   recommended to import the [config/checkstyle/checkstyle.xml](../config/checkstyle/checkstyle.xml)
   or [config/intellij-code-style.xml](../config/intellij-code-style.xml) file into your
@@ -47,7 +48,7 @@ Because we use merge commits when merging a PR, branch names will be part of the
 branch names must follow a certain standard.
 
 The format is `{category}/GH-{issue number}/{lowercase-description}` and a branch name can be maximum 50 characters of
-length.
+length. You can also use `NO-ISSUE` instead of a GitHub issue number.
 
 Category must match a
 category [used in our Commitlint config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum).
@@ -140,7 +141,7 @@ easily set up networks for testing.
 ### Integration testing
 
 To test the entire chain from Minecraft to the API modules, we use integration tests. These tests are located in the
-test source set of the `refinedstorage-platform-neoforge` module.
+test source set of the `refinedstorage-neoforge` module.
 
 We write these integration tests as Minecraft gametests.
 
@@ -150,8 +151,8 @@ Our [SonarQube quality gate](https://sonarcloud.io/organizations/refinedmods/qua
 test coverage percentage of 80%. This an aggregated percentage over all
 the API modules, with an exclusion for the platform modules.
 
-> The `refinedstorage-platform-*` modules are excluded because they contain a lot of Minecraft-specific code and are
-> harder to test.
+> The `refinedstorage-neoforge` and `refinedstorage-fabric` modules are excluded because they contain a lot of
+> Minecraft-specific code and are harder to test.
 
 ### Mutation testing
 
@@ -260,22 +261,23 @@ The workflow takes care of the following:
 
 ## Modules
 
-Refined Storage is split up into various modules.
-
-Most modules aren't dependent on Minecraft or a mod loader. Only modules that start
-with `refinedstorage-platform-*` have dependencies on Minecraft.
-
-| Name                             | Use in addons | Description                                                                                        |
-|----------------------------------|---------------|----------------------------------------------------------------------------------------------------|
-| `refinedstorage-core-api`        | ✔️            | Contains some utility classes and enums.                                                           |
-| `refinedstorage-grid-api`        | ✔️            | Contains Grid related functionality.                                                               |
-| `refinedstorage-network-api`     | ✔️            | Contains storage network related functionality.                                                    |
-| `refinedstorage-network`         | ❌             | Contains implementations of `refinedstorage-network-api`.                                          |
-| `refinedstorage-network-test`    | ✔️            | JUnit extension which helps with setting up a network and a network node for testing.              |
-| `refinedstorage-query-parser`    | ✔️            | A query parser, contains a lexer and parser. Only used for Grid query parsing.                     |
-| `refinedstorage-resource-api`    | ✔️            | Contains API for handling resources.                                                               |
-| `refinedstorage-storage-api`     | ✔️            | Contains storage related functionality.                                                            |
-| `refinedstorage-platform-api`    | ✔️            | Implements the various Refined Storage API modules for use in Minecraft.                           |
-| `refinedstorage-platform-fabric` | ❌             | The platform module for Fabric. This module contains Fabric specific code.                         |
-| `refinedstorage-platform-forge`  | ❌             | The platform module for Forge. This module contains Forge specific code and the integration tests. |
-| `refinedstorage-platform-common` | ❌             | Common mod code. Most gameplay code is in here.                                                    |
+Refined Storage is split up into various modules. Most modules aren't dependent on Minecraft or a mod loader. Only
+the `refinedstorage-common`, `refinedstorage-neoforge` and `refinedstorage-fabric` modules have dependencies on
+Minecraft.
+
+| Name                          | Use in addons | Description                                                                                              |
+|-------------------------------|---------------|----------------------------------------------------------------------------------------------------------|
+| `refinedstorage-core-api`     | ✔️            | Contains some utility classes and enums.                                                                 |
+| `refinedstorage-grid-api`     | ✔️            | Contains Grid related functionality.                                                                     |
+| `refinedstorage-network-api`  | ✔️            | Contains storage network related functionality.                                                          |
+| `refinedstorage-network`      | ❌             | Contains implementations of `refinedstorage-network-api`.                                                |
+| `refinedstorage-network-test` | ✔️            | JUnit extension which helps with setting up a network and a network node for testing.                    |
+| `refinedstorage-query-parser` | ✔️            | A query parser, contains a lexer and parser. Only used for Grid query parsing.                           |
+| `refinedstorage-resource-api` | ✔️            | Contains API for handling resources.                                                                     |
+| `refinedstorage-storage-api`  | ✔️            | Contains storage related functionality.                                                                  |
+| `refinedstorage-common-api`   | ✔️            | Implements the various Refined Storage API modules for use in Minecraft.                                 |
+| `refinedstorage-common`       | ❌             | Common mod code. Most gameplay code is in here.                                                          |
+| `refinedstorage-fabric-api`   | ✔️            | Additional API for the Fabric platform.                                                                  |
+| `refinedstorage-fabric`       | ❌             | The platform module for Fabric. This module contains Fabric specific code.                               |
+| `refinedstorage-neoforge-api` | ✔️            | Additional API for the NeoForge platform.                                                                |
+| `refinedstorage-neoforge`     | ❌             | The platform module for NeoForge. This module contains NeoForge specific code and the integration tests. |

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,6 @@
+#file: noinspection YAMLSchemaValidation,YAMLSchemaValidation
 blank_issues_enabled: true
 contact_links:
-    -   name: Discord Community Support
-        url: https://discordapp.com/invite/VYzsydb
-        about: Please ask and answer questions here. Issues should be used for bugs and feature requests.
+  - name: Discord Community Support
+    url: https://discordapp.com/invite/VYzsydb
+    about: Please ask and answer questions here. Issues should be used for bugs and feature requests.

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -2,22 +2,22 @@ name: Enhancement
 description: Do you have a suggestion for a new feature or improvement? Let us know.
 labels: [ enhancement ]
 body:
-    -   type: markdown
-        attributes:
-            value: |
-                Provide a summary of the enhancement in the title above.
-
-                Please follow following guidelines before proposing an enchancement:
-                1) Ensure that you are running on the latest version (to ensure that the enhancement does not exist yet).
-                2) Ensure that your enhancement hasn't already been posted. Please look in the closed issues as well (for enhancements that have been denied).
-
-                We might close your issue, without explanation, if you do not follow these guidelines.
-    -   type: textarea
-        id: describe
-        attributes:
-            label: Describe your enhancement
-            description: |
-                Be as detailed as possible.
-                Tell us how your idea should work. Why should we consider this?
-        validations:
-            required: true
+  - type: markdown
+    attributes:
+      value: |
+        Provide a summary of the enhancement in the title above.
+        
+        Please follow following guidelines before proposing an enchancement:
+        1) Ensure that you are running on the latest version (to ensure that the enhancement does not exist yet).
+        2) Ensure that your enhancement hasn't already been posted. Please look in the closed issues as well (for enhancements that have been denied).
+        
+        We might close your issue, without explanation, if you do not follow these guidelines.
+  - type: textarea
+    id: describe
+    attributes:
+      label: Describe your enhancement
+      description: |
+        Be as detailed as possible.
+        Tell us how your idea should work. Why should we consider this?
+    validations:
+      required: true

.github/workflows/build.yml

@@ -8,7 +8,7 @@ on:
     types: [ opened, synchronize, reopened ]
 jobs:
   build:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9
     with:
       gametests: true
     secrets: inherit

.github/workflows/draft-release.yml

@@ -17,7 +17,7 @@ on:
         type: string
 jobs:
   draft:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9
     with:
       release-type: ${{ inputs.release-type }}
       version-number-override: ${{ inputs.version-number-override }}

.github/workflows/issue-for-unsupported-version.yml

@@ -4,4 +4,4 @@ on:
     types: [ labeled, unlabeled, reopened ]
 jobs:
   unsupported-labeler:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9

.github/workflows/publish-release.yml

@@ -7,7 +7,7 @@ on:
       - closed
 jobs:
   publish-release:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9
     secrets: inherit
     with:
       project-name: 'Refined Storage'

.github/workflows/resolved-issue-locking.yml

@@ -1,7 +1,7 @@
 name: Lock resolved issues and PRs
 on:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: '0 0 * * 1'
 jobs:
   lock:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9

.github/workflows/validate-branch-name.yml

@@ -2,4 +2,4 @@ name: Validate branch name
 on: [ pull_request ]
 jobs:
   validate-branch-name:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9

.github/workflows/validate-changelog.yml

@@ -4,4 +4,4 @@ on:
     types: [ opened, synchronize, reopened, ready_for_review, labeled, unlabeled ]
 jobs:
   validate-changelog:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9

.github/workflows/validate-commit-messages.yml

@@ -2,4 +2,4 @@ name: Validate commit messages
 on: [ pull_request ]
 jobs:
   validate-commit-messages:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].4
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected].9

.gitignore

@@ -12,6 +12,7 @@ eclipse/
 *.iws
 .idea/
 !.idea/dictionaries/refinedstorage.xml
+!.idea/inspectionProfiles/refinedstorage.xml
 !.idea/icon.png
 out/
 /bin/