Add reading assistant

.github/workflows/ci.yml

@@ -1,76 +0,0 @@
-name: OpenInv CI
-
-on:
-  push:
-  pull_request_target:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v2
-
-      - name: Set Up Java
-        uses: actions/setup-java@v1
-        with:
-          java-version: 1.8
-
-      # Use cache to speed up build
-      - name: Cache Maven Repo
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: ~/.m2/repository
-          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-
-      # Install Spigot dependencies.
-      # This script uses Maven to check all required installations and ensure that they are present.
-      - name: Install Spigot Dependencies
-        run: . scripts/install_spigot_dependencies.sh
-
-      - name: Build With Maven
-        run: mvn -e clean package -am -P all
-
-      # Upload artifacts
-      - name: Upload Distributable Jar
-        id: upload-final
-        uses: actions/upload-artifact@v2
-        with:
-          name: dist
-          path: ./target/OpenInv.jar
-      - name: Upload API Jar
-        id: upload-api
-        uses: actions/upload-artifact@v2
-        with:
-          name: api
-          path: ./api/target/openinvapi*.jar
-
-  release:
-    name: Create Github Release
-    needs: [ build ]
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-
-      - name: Set Release Variables
-        run: bash ./scripts/set_release_env.sh
-
-      - name: Download Artifacts
-        uses: actions/download-artifact@v2
-
-      - name: Create Release
-        id: create-release
-        uses: softprops/action-gh-release@v0.1.5
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          name: ${{ env.VERSIONED_NAME }}
-          body: ${{ env.GENERATED_CHANGELOG }}
-          draft: true
-          prerelease: false
-          files: ./dist/OpenInv.jar

.github/workflows/close-issue.yml

@@ -0,0 +1,13 @@
+name: Close Issue
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/close-issue@v1.0.3
+        with:
+          comment: "Per the notice in the readme, OpenInv is now being maintained at [Jikoo/OpenInv](https://github.com/Jikoo/OpenInv)."

.github/workflows/close-pr.yml

@@ -0,0 +1,13 @@
+name: Close Pull Request
+
+on:
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: superbrothers/close-pull-request@v3.1.0
+        with:
+          comment: "Per the notice in the readme, OpenInv is now being maintained at [Jikoo/OpenInv](https://github.com/Jikoo/OpenInv)."

.github/workflows/release.yml

@@ -1,42 +0,0 @@
-name: Release to CurseForge
-
-on:
-  release:
-    types: [ released ]
-
-jobs:
-  curseforge_release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-
-      - name: Set CurseForge Variables
-        run: . scripts/set_curseforge_env.sh
-
-      - name: Fetch Github Release Asset
-        uses: dsaltares/fetch-gh-release-asset@0.0.5
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          version: ${{ github.event.release.id }}
-          file: OpenInv.jar
-
-      - name: Convert to HTML
-        id: convert_to_html
-        uses: lifepal/markdown-to-html@v1.2
-        with:
-          text: ${{ github.event.release.body }}
-
-      - name: Create CurseForge Release
-        uses: itsmeow/curseforge-upload@v3
-        with:
-          token: ${{ secrets.CURSEFORGE_TOKEN }}
-          project_id: 31432
-          game_endpoint: minecraft
-          file_path: ./OpenInv.jar
-          changelog: ${{ steps.convert_to_html.outputs.html }}
-          display_name: ${{ github.event.release.name }}
-          game_versions: ${{ env.CURSEFORGE_MINECRAFT_VERSIONS }}
-          release_type: release

README.MD

@@ -1,3 +1,6 @@
+## Notice
+I am now maintaining OpenInv over at [Jikoo/OpenInv](https://github.com/Jikoo/OpenInv) because I needed higher levels of access to add secrets to the repository for Github Actions. It feels ruder to send an email saying what amounts to "pls op" than to redirect people to my fork, though neither option is polite. Existing issues will remain open here until resolved (you can't transfer issues across organizations/users), but any new issues in this repo will be closed without resolution.
+
 ## About
 OpenInv is a [Bukkit plugin](https://dev.bukkit.org/bukkit-plugins/openinv/) which allows users to open and edit anyone's inventory or ender chest - online or not!
 

api/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>com.lishid</groupId>
     <artifactId>openinvparent</artifactId>
-    <version>4.1.6</version>
+    <version>4.1.6-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvapi</artifactId>

assembly/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>com.lishid</groupId>
     <artifactId>openinvparent</artifactId>
-    <version>4.1.6</version>
+    <version>4.1.6-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvassembly</artifactId>

internal/pom.xml

@@ -20,7 +20,7 @@
   <parent>
     <groupId>com.lishid</groupId>
     <artifactId>openinvparent</artifactId>
-    <version>4.1.6</version>
+    <version>4.1.6-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvinternal</artifactId>

internal/v1_16_R3/pom.xml

@@ -22,7 +22,7 @@
   <parent>
     <groupId>com.lishid</groupId>
     <artifactId>openinvinternal</artifactId>
-    <version>4.1.6</version>
+    <version>4.1.6-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvadapter1_16_R3</artifactId>
@@ -38,7 +38,7 @@
     <dependency>
       <groupId>com.lishid</groupId>
       <artifactId>openinvplugincore</artifactId>
-      <version>4.1.6</version>
+      <version>4.1.6-SNAPSHOT</version>
     </dependency>
   </dependencies>
 

plugin/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>com.lishid</groupId>
     <artifactId>openinvparent</artifactId>
-    <version>4.1.6</version>
+    <version>4.1.6-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvplugincore</artifactId>
@@ -31,7 +31,7 @@
     <dependency>
       <groupId>com.lishid</groupId>
       <artifactId>openinvapi</artifactId>
-      <version>4.1.6</version>
+      <version>4.1.6-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>org.spigotmc</groupId>

plugin/src/main/java/com/lishid/openinv/util/InternalAccessor.java

@@ -84,7 +84,7 @@ public class InternalAccessor {
                 return "https://github.com/lishid/OpenInv/releases/tag/4.1.5";
             case "v1_16_R3":
             default:
-                return "https://github.com/Jikoo/OpenInv/releases";
+                return "https://github.com/lishid/OpenInv/releases";
         }
     }
 

pom.xml

@@ -19,9 +19,9 @@
 
   <groupId>com.lishid</groupId>
   <artifactId>openinvparent</artifactId>
-  <name>OpenInv</name>
+  <name>OpenInvParent</name>
   <url>http://dev.bukkit.org/bukkit-plugins/openinv/</url>
-  <version>4.1.6</version>
+  <version>4.1.6-SNAPSHOT</version>
 
   <packaging>pom</packaging>
 

scripts/generate_changelog.sh

@@ -15,12 +15,14 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 
+# A script for generating a changelog from Git.
+#
 # Note that this script is designed for use in GitHub Actions, and is not
 # particularly robust nor configurable. Run from project parent directory.
 
 # Query GitHub for the username of the given email address.
 # Falls through to the given author name.
-function lookup_email_username() {
+lookup_email_username() {
   lookup=$(curl -G --data-urlencode "q=$1 in:email" https://api.github.com/search/users -H 'Accept: application/vnd.github.v3+json' | grep '"login":' | sed -e 's/^.*": "//g' -e 's/",.*$//g')
 
   if [[ $lookup ]]; then
@@ -30,25 +32,10 @@ function lookup_email_username() {
   fi
 }
 
-# Get a pretty list of supported Minecraft versions
-function get_minecraft_versions() {
-  versions=$(. ./scripts/get_spigot_versions.sh)
-
-  for version in "${versions[@]}"; do
-    # Append comma if variable is set, then append version
-    minecraft_versions="${minecraft_versions:+${minecraft_versions},}${version%%-R*}"
-  done
-
-  echo "${minecraft_versions}"
-}
-
-previous_tag=$(git describe --tags --abbrev=0 @^)
-
 # Use formatted log to pull authors list
-authors_raw=$(git log --pretty=format:"%ae|%an" "$previous_tag"..@)
+authors_raw=$(git log --pretty=format:"%ae|%an" "$(git describe --tags --abbrev=0 @^)"..@)
 readarray -t authors <<<"$authors_raw"
 
-# Use associative array to map email to author name
 declare -A author_data
 
 for author in "${authors[@]}"; do
@@ -68,7 +55,7 @@ for author in "${authors[@]}"; do
 done
 
 # Fetch actual formatted changelog
-changelog=$(git log --pretty=format:"* %s (%h) - %ae" "$previous_tag"..@)
+changelog=$(git log --pretty=format:"%s (%h) - %ae" "$(git describe --tags --abbrev=0 @^)"..@)
 
 for author_email in "${!author_data[@]}"; do
   # Ignore case when matching
@@ -77,6 +64,4 @@ for author_email in "${!author_data[@]}"; do
   changelog=${changelog//$author_email/${author_data[$author_email]}}
 done
 
-minecraft_versions=$(get_minecraft_versions)
-
-printf "## Supported Minecraft versions\n%s\n\n## Changelog\n%s" "${minecraft_versions}" "${changelog}"
+echo "GENERATED_CHANGELOG<<EOF${changelog}EOF" >> "$GITHUB_ENV"

scripts/get_spigot_versions.sh

@@ -1,56 +0,0 @@
-#!/bin/bash
-#
-# Copyright (C) 2011-2021 lishid. All rights reserved.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-
-# Note that this script is designed for use in GitHub Actions, and is not
-# particularly robust nor configurable. Run from project parent directory.
-
-# Use a nameref as a cache - maven evaluation is pretty slow.
-# Re-calling the script and relying on it to handle caching is way easier than passing around info.
-declare -a spigot_versions
-
-# We don't care about concatenation - either it's not null and we return or it's null and we instantiate.
-# shellcheck disable=SC2199
-if [[ ${spigot_versions[@]} ]]; then
-  for spigot_version in "${spigot_versions[@]}"; do
-    echo "$spigot_version"
-  done
-  return
-fi
-
-# Pull Spigot dependency information from Maven.
-modules=$(mvn help:evaluate -Dexpression=project.modules -q -DforceStdout -P all -pl internal | grep -oP '(?<=<string>)(.*)(?=<\/string>)')
-
-declare -n versions="spigot_versions"
-
-for module in "${modules[@]}"; do
-  # Get number of dependencies declared in pom of specified internal module.
-  max_index=$(mvn help:evaluate -Dexpression=project.dependencies -q -DforceStdout -P all -pl internal/"$module" | grep -c "<dependency>")
-
-  for ((i=0; i < max_index; i++)); do
-    # Get artifactId of dependency.
-    artifact_id=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].artifactId -q -DforceStdout -P all -pl internal/"$module")
-
-    # Ensure dependency is Spigot.
-    if [[ "$artifact_id" == spigot ]]; then
-      # Get Spigot version.
-      spigot_version=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].version -q -DforceStdout -P all -pl internal/"$module")
-      versions+=("$spigot_version")
-      echo "$spigot_version"
-      break
-    fi
-  done
-done

scripts/install_spigot_dependencies.sh

@@ -15,12 +15,39 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 
-# Note that this script is designed for use in GitHub Actions, and is not
-# particularly robust nor configurable. Run from project parent directory.
+# A script for installing required Spigot versions.
+#
+# Note that this script is designed for use in GitHub Actions, and is
+# not particularly robust nor configurable.
+# In its current state, the script must be run from OpenInv's parent
+# project directory and will always install BuildTools to ~/buildtools.
 
 buildtools_dir=~/buildtools
 buildtools=$buildtools_dir/BuildTools.jar
 
+get_spigot_versions () {
+  # Get all submodules of internal module
+  modules=$(mvn help:evaluate -Dexpression=project.modules -q -DforceStdout -P all -pl internal | grep -oP '(?<=<string>)(.*)(?=<\/string>)')
+  for module in "${modules[@]}"; do
+
+    # Get number of dependencies declared in pom of specified internal module
+    max_index=$(mvn help:evaluate -Dexpression=project.dependencies -q -DforceStdout -P all -pl internal/"$module" | grep -c "<dependency>")
+
+    for ((i=0; i < max_index; i++)); do
+      # Get artifactId of dependency
+      artifact_id=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].artifactId -q -DforceStdout -P all -pl internal/"$module")
+
+      # Ensure dependency is spigot
+      if [[ "$artifact_id" == spigot ]]; then
+        # Get spigot version
+        spigot_version=$(mvn help:evaluate -Dexpression=project.dependencies["$i"].version -q -DforceStdout -P all -pl internal/"$module")
+        echo "$spigot_version"
+        break
+      fi
+    done
+  done
+}
+
 get_buildtools () {
   if [[ -d $buildtools_dir && -f $buildtools ]]; then
     return
@@ -30,7 +57,7 @@ get_buildtools () {
   wget https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar -O $buildtools
 }
 
-versions=$(. ./scripts/get_spigot_versions.sh)
+versions=$(get_spigot_versions)
 echo Found Spigot dependencies: "$versions"
 
 for version in "${versions[@]}"; do
@@ -39,7 +66,7 @@ for version in "${versions[@]}"; do
   mvn dependency:get -Dartifact=org.spigotmc:spigot:"$version" -q -o || exit_code=$?
   if [ $exit_code -ne 0 ]; then
     echo Installing missing Spigot version "$version"
-    revision=${version%%-R*}
+    revision=$(echo "$version" | grep -oP '(\d+\.\d+(\.\d+)?)(?=-R[0-9\.]+-SNAPSHOT)')
     get_buildtools
     java -jar $buildtools -rev "$revision"
   else

scripts/set_curseforge_env.sh

@@ -1,42 +0,0 @@
-#!/bin/bash
-#
-# Copyright (C) 2011-2021 lishid. All rights reserved.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-
-# Note that this script is designed for use in GitHub Actions, and is not
-# particularly robust nor configurable. Run from project parent directory.
-
-# Parse Spigot dependency information into major Minecraft versions
-function get_curseforge_minecraft_versions() {
-  versions=$(. ./scripts/get_spigot_versions.sh)
-
-  for version in "${versions[@]}"; do
-    # Parse Minecraft major version
-    version="${version%[.-]"${version#*.*[.-]}"}"
-
-    # Skip already listed versions
-    if [[ "$minecraft_versions" =~ "$version"($|,) ]]; then
-      continue
-    fi
-
-    # Append comma if variable is set, then append version
-    minecraft_versions="${minecraft_versions:+${minecraft_versions},}Minecraft ${version}"
-  done
-
-  echo "${minecraft_versions}"
-}
-
-minecraft_versions=$(get_curseforge_minecraft_versions)
-echo "CURSEFORGE_MINECRAFT_VERSIONS=$minecraft_versions" >> "$GITHUB_ENV"

scripts/set_release_env.sh

@@ -1,32 +0,0 @@
-#!/bin/bash
-#
-# Copyright (C) 2011-2021 lishid. All rights reserved.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-
-# Note that this script is designed for use in GitHub Actions, and is not
-# particularly robust nor configurable. Run from project parent directory.
-
-# Get a pretty string of the project's name and version
-# Disable SC warning about variable expansion for this function - those are Maven variables.
-# shellcheck disable=SC2016
-function get_versioned_name() {
-  mvn -q -Dexec.executable=echo -Dexec.args='${project.name} ${project.version}' --non-recursive exec:exec
-}
-
-# Set GitHub environmental variables
-echo "VERSIONED_NAME=$(get_versioned_name)" >> "$GITHUB_ENV"
-
-changelog="$(. ./scripts/generate_changelog.sh)"
-printf "GENERATED_CHANGELOG<<EOF\n%s\nEOF\n" "$changelog" >> "$GITHUB_ENV"

scripts/tag_release.sh

@@ -1,37 +0,0 @@
-#!/bin/bash
-#
-# Copyright (C) 2011-2021 lishid. All rights reserved.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-
-if [[ ! $1 ]]; then
-  echo "Please provide a version string."
-  return
-fi
-
-version="$1"
-snapshot="${version%.*}.$((${version##*.} + 1))-SNAPSHOT"
-
-mvn versions:set -DnewVersion="$version"
-
-git add .
-git commit -S -m "Bump version to $version for release"
-git tag -s "$version" -m "Release $version"
-
-mvn clean package -am -P all
-
-mvn versions:set -DnewVersion="$snapshot"
-
-git add .
-git commit -S -m "Bump version to $snapshot for development"