From 66c3e60a6fcea1eebef7c61023d2ad143736fa45 Mon Sep 17 00:00:00 2001 From: Daniel Date: Wed, 9 Sep 2020 14:47:02 -0400 Subject: [PATCH] Updating To Gradlew and New Command Framework --- .../CODE_OF_CONDUCT.md | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 16 +- .github/auto-merge.yml | 6 + .github/dependabot.yml | 15 + .../workflows/auto-approve-dependabot.yaml | 13 + .github/workflows/gradle.yml | 114 + .gitignore | 223 +- .nvmrc | 1 + .travis.yml | 2 - CHANGELOG.md | 238 + CONTRIBUTING.md | 168 + README.md | 25 - World System.ipr | 104 + build.gradle | 209 + commitlint.config.js | 36 + gradle.properties | 7 + gradle/jacoco.gradle | 10 + gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 55741 bytes gradle/wrapper/gradle-wrapper.properties | 5 + gradlew | 172 + gradlew.bat | 84 + lib/commons-io-2.7.jar | Bin 0 -> 276413 bytes lib/simple-commands.jar | Bin 0 -> 66540 bytes package.json | 63 + pom.xml | 198 - renovate.json | 10 + settings.gradle | 1 + .../java/de/butzlabben/world/WorldSystem.java | 35 +- .../world/command/CommandRegistry.java | 93 + .../butzlabben/world/command/WSCommand.java | 259 - .../command/WorldAdministrateCommand.java | 309 - .../world/command/commands/WSCommands.java | 288 + .../commands/WorldAdministrateCommand.java | 332 ++ .../{ => commands}/WorldSettingsCommands.java | 509 +- .../butzlabben/world/config/PluginConfig.java | 2 +- .../world/util/PlayerPositions.java | 4 +- .../world/util/database/DatabaseProvider.java | 6 +- .../butzlabben/world/wrapper/SystemWorld.java | 8 +- .../world/wrapper/WorldTemplate.java | 12 +- src/main/resources/config.yml | 13 +- src/main/resources/plugin.yml | 74 - yarn.lock | 5306 +++++++++++++++++ 42 files changed, 7791 insertions(+), 1181 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (98%) create mode 100644 .github/auto-merge.yml create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/auto-approve-dependabot.yaml create mode 100644 .github/workflows/gradle.yml create mode 100644 .nvmrc delete mode 100644 .travis.yml create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md delete mode 100644 README.md create mode 100644 World System.ipr create mode 100644 build.gradle create mode 100644 commitlint.config.js create mode 100644 gradle.properties create mode 100644 gradle/jacoco.gradle create mode 100644 gradle/wrapper/gradle-wrapper.jar create mode 100644 gradle/wrapper/gradle-wrapper.properties create mode 100644 gradlew create mode 100644 gradlew.bat create mode 100644 lib/commons-io-2.7.jar create mode 100644 lib/simple-commands.jar create mode 100644 package.json delete mode 100644 pom.xml create mode 100644 renovate.json create mode 100644 settings.gradle create mode 100644 src/main/java/de/butzlabben/world/command/CommandRegistry.java delete mode 100644 src/main/java/de/butzlabben/world/command/WSCommand.java delete mode 100644 src/main/java/de/butzlabben/world/command/WorldAdministrateCommand.java create mode 100644 src/main/java/de/butzlabben/world/command/commands/WSCommands.java create mode 100644 src/main/java/de/butzlabben/world/command/commands/WorldAdministrateCommand.java rename src/main/java/de/butzlabben/world/command/{ => commands}/WorldSettingsCommands.java (61%) delete mode 100644 src/main/resources/plugin.yml create mode 100644 yarn.lock diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 98% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md index 8e16168..dde5021 100644 --- a/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at darkstylerz@web.de. All +reported by contacting the project team at me@silthus.net. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..4cdfb38 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug report about: Create a report to help us improve -title: '' +title: "[BUG]" labels: '' assignees: '' @@ -23,16 +23,10 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +**Server Information (please complete the following information):** +- Server version (`/bukkit:version`): +- Installed plugins (`/bukkit:plugins`): +- WorldGuard Report Pastebin Link (`/wg report -p`): **Additional context** Add any other context about the problem here. diff --git a/.github/auto-merge.yml b/.github/auto-merge.yml new file mode 100644 index 0000000..fe38df1 --- /dev/null +++ b/.github/auto-merge.yml @@ -0,0 +1,6 @@ +minApprovals: + NONE: 0 +requiredLabels: + - dependencies +updateBranch: true +mergeMethod: rebase \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..8102cba --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "gradle" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "daily" + - package-ecosystem: "npm" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "daily" diff --git a/.github/workflows/auto-approve-dependabot.yaml b/.github/workflows/auto-approve-dependabot.yaml new file mode 100644 index 0000000..d6aa5b8 --- /dev/null +++ b/.github/workflows/auto-approve-dependabot.yaml @@ -0,0 +1,13 @@ +name: Auto approve + +on: + pull_request + +jobs: + auto-approve: + runs-on: ubuntu-latest + steps: + - uses: hmarr/auto-approve-action@v2.0.0 + if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml new file mode 100644 index 0000000..9c341c3 --- /dev/null +++ b/.github/workflows/gradle.yml @@ -0,0 +1,114 @@ +name: Build +on: [push] +jobs: + build: + + runs-on: ubuntu-18.04 + # We want to run on external PRs, but not on our own internal PRs as they'll be run + # by the push to the branch. + if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository + + + steps: + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 11 + + - name: Cache Gradle + id: cache-gradle + uses: actions/cache@v1 + with: + path: ~/.gradle + key: ${{ runner.os }}-gradle + + - uses: actions/checkout@v1 + + - name: Grant execute permission to gradlew + run: chmod +x gradlew + + - name: Build + run: ./gradlew build -x test + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Upload build artifacts + uses: actions/upload-artifact@v2 + with: + path: "**/build/libs" + + test: + + runs-on: ubuntu-18.04 + + steps: + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 11 + + - name: Cache Gradle + id: cache-gradle + uses: actions/cache@v1 + with: + path: ~/.gradle + key: ${{ runner.os }}-gradle + + - uses: actions/checkout@v1 + + - name: Grant execute permission to gradlew + run: chmod +x gradlew + + - name: Test + run: ./gradlew test + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Upload CodeCov Report + uses: codecov/codecov-action@v1 + with: + file: "**/build/reports/jacoco/**/*.xml" + + - name: Upload Test Report + uses: actions/upload-artifact@v2 + if: always() + with: + name: build reports + path: "**/build/reports" + + release: + needs: [build, test] + if: github.ref == 'refs/heads/master' + + runs-on: ubuntu-18.04 + + steps: + - name: Set up JDK 8 + uses: actions/setup-java@v1 + with: + java-version: 8 + + - name: Set up Node.js v12.x + uses: actions/setup-node@v1 + with: + node-version: "12.x" + + - name: Cache Gradle + id: cache-gradle + uses: actions/cache@v1 + with: + path: ~/.gradle + key: ${{ runner.os }}-gradle + + - uses: actions/checkout@v1 + + - name: Grant execute permission for gradlew + run: chmod +x gradlew + + - name: Release + run: | + yarn install + yarn semantic-release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_URL: "https://api.github.com/" diff --git a/.gitignore b/.gitignore index 31ee674..be6a4d1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,25 +1,208 @@ -# Maven -target/ -pom.xml.tag -pom.xml.releaseBackup -pom.xml.versionsBackup -pom.xml.next -release.properties -dependency-reduced-pom.xml -buildNumber.properties -.mvn/timing.properties +# IntelliJ -# Eclipse -bin/ -.settings -.project -.classpath +/.idea/dictionaries/ +/.idea/libraries/ +/.idea/*.xml +*.iml + +# Gradle + +.gradle +build/ + +# Server +working/* +**/debug/**/* +!working/server.properties +/.idea/ + +src/**/plugin.yml + +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws # IntelliJ out/ -.idea/ -*.iml -.idea/vcs.xml -# Misc -.DS_Store +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env +.env.test + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist + +# Gatsby files +.cache/ +# Comment in the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +# public + +# vuepress build output +.vuepress/dist + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# TernJS port file +.tern-port + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# yarn v2 + +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.pnp.* \ No newline at end of file diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..3cacc0b --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +12 \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 9b16d57..0000000 --- a/.travis.yml +++ /dev/null @@ -1,2 +0,0 @@ -language: java -jdk: openjdk8 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2727c33 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,238 @@ +## [2.0.1](https://github.com/Silthus/spigot-plugin-template/compare/v2.0.0...v2.0.1) (2020-07-06) + + +### Bug Fixes + +* **debug:** exclude all content inside debug/ ([751d2b7](https://github.com/Silthus/spigot-plugin-template/commit/751d2b7057a57330851968cb9c9bafad82f09d56)) + +# [2.0.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.7.1...v2.0.0) (2020-07-06) + + +### Features + +* update spigradle to 2.0.0 ([df1f431](https://github.com/Silthus/spigot-plugin-template/commit/df1f431c6cb68bab085a182970c33cd0e96cddca)), closes [#19](https://github.com/Silthus/spigot-plugin-template/issues/19) + + +### BREAKING CHANGES + +* The `@Plugin` annotation on the plugin main class for spigradle was renamed to `@PluginMain` + +## [1.7.1](https://github.com/Silthus/spigot-plugin-template/compare/v1.7.0...v1.7.1) (2020-07-03) + + +### Bug Fixes + +* target Minecraft 1.16.1 in gradle.properties ([8beb34a](https://github.com/Silthus/spigot-plugin-template/commit/8beb34a733787bd4c7cdb814a60234be2b3e981e)) + +# [1.7.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.6.0...v1.7.0) (2020-07-02) + + +### Features + +* use new spigradle debug task for running the server ([d7a3f25](https://github.com/Silthus/spigot-plugin-template/commit/d7a3f25a694ab92e03ebc7bf9058264b5324acf1)) + +# [1.6.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.5.2...v1.6.0) (2020-06-25) + + +### Features + +* **build:** split build and test into separate jobs ([38f74d4](https://github.com/Silthus/spigot-plugin-template/commit/38f74d48d258521f9414d1f050cacb7201cf6bfd)) + +## [1.5.2](https://github.com/Silthus/spigot-plugin-template/compare/v1.5.1...v1.5.2) (2020-06-25) + + +### Bug Fixes + +* **build:** only run once on PR from same repo ([4df7f57](https://github.com/Silthus/spigot-plugin-template/commit/4df7f5701a2c47c46bf5394f544ca5fdf4d8bec4)) + +## [1.5.1](https://github.com/Silthus/spigot-plugin-template/compare/v1.5.0...v1.5.1) (2020-06-10) + + +### Bug Fixes + +* **docs:** remove invalid whitespaces from gradle.properties ([d3fd4b5](https://github.com/Silthus/spigot-plugin-template/commit/d3fd4b53f1d7c1bd4f331f92b1651f89682b3122)) + +# [1.5.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.4.0...v1.5.0) (2020-06-10) + + +### Features + +* auto update dependencies with dependabot ([e28ccf4](https://github.com/Silthus/spigot-plugin-template/commit/e28ccf4cbb64ee9975b23c974b50ad1f0a4315f9)) + +# [1.4.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.7...v1.4.0) (2020-06-08) + + +### Features + +* **docs:** add spiget shields to spigot resource ([0907394](https://github.com/Silthus/spigot-plugin-template/commit/090739466d919f7b6f3fe24c3a2fade87129732d)) + +## [1.3.7](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.6...v1.3.7) (2020-05-25) + + +### Bug Fixes + +* **build:** copy plugin to server based on rootProject.rootDir ([1315050](https://github.com/Silthus/spigot-plugin-template/commit/1315050ac27aa8740672a773ad6fc9fa14ee180e)) +* **git:** ignore automatic generated plugin.yml ([4cccd5b](https://github.com/Silthus/spigot-plugin-template/commit/4cccd5b1197311dd456bb742c2ec5cb06dcadb8f)) +* **plugin:** set correct spigradle plugin name ([a7d5af5](https://github.com/Silthus/spigot-plugin-template/commit/a7d5af590f8b8b06bf5350bff8e25059cdc4f7d6)) + +## [1.3.6](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.5...v1.3.6) (2020-05-24) + + +### Bug Fixes + +* **release:** override GitHub API url with GH_URL ([43669f7](https://github.com/Silthus/spigot-plugin-template/commit/43669f730eee93f4c62a9bae1d0666a9513a8046)) + +## [1.3.5](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.4...v1.3.5) (2020-05-23) + + +### Bug Fixes + +* **build:** hash yarn.lock for cache ([307b744](https://github.com/Silthus/spigot-plugin-template/commit/307b744c7a15fe940d1d8e967e44c93a3063cc67)) + + +### Reverts + +* publish shadowJar artifact ([6e869fc](https://github.com/Silthus/spigot-plugin-template/commit/6e869fcc11de056faad831f215c80538c112435b)) + +## [1.3.4](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.3...v1.3.4) (2020-05-23) + + +### Bug Fixes + +* **test:** copy plugin.yml to test resources ([54893f2](https://github.com/Silthus/spigot-plugin-template/commit/54893f201d37958e2fc1b07dfb403014d09ff1c0)) + +## [1.3.3](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.2...v1.3.3) (2020-05-23) + + +### Bug Fixes + +* **plugin:** use pluginName property in plugin.yml ([094c57b](https://github.com/Silthus/spigot-plugin-template/commit/094c57b3730178470b60b7038950be8e1ced6c51)) +* **publish:** publish shadow jar artifact ([64968ce](https://github.com/Silthus/spigot-plugin-template/commit/64968cefa69d10fea0f3a26b2d3da7abc1e627d5)) + +## [1.3.2](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.1...v1.3.2) (2020-05-23) + + +### Bug Fixes + +* **build:** cache node correctly ([20bb9e3](https://github.com/Silthus/spigot-plugin-template/commit/20bb9e349a16efb5712c037b1786358447bfdda1)) + +## [1.3.1](https://github.com/Silthus/spigot-plugin-template/compare/v1.3.0...v1.3.1) (2020-05-22) + + +### Bug Fixes + +* **release:** update semantic-release/GitHub ([aefa8c1](https://github.com/Silthus/spigot-plugin-template/commit/aefa8c1c9e250dc4df9e1707c096bf7e91b8b79d)) + +# [1.3.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.2.0...v1.3.0) (2020-05-20) + + +### Bug Fixes + +* **publish:** revert publishing to project namespace ([4f2aa72](https://github.com/Silthus/spigot-plugin-template/commit/4f2aa72fd4aeb065fce5db6b8a137d9aa2e2c148)) +* **tests:** output jacoco html report for intellij coverage ([7f94567](https://github.com/Silthus/spigot-plugin-template/commit/7f945670a9d63265be695d9adb21dbf0f24ead2b)) + + +### Features + +* **publish:** publish github package to user namespace ([ac38c81](https://github.com/Silthus/spigot-plugin-template/commit/ac38c811219942159901e5a177f71c9bb2e1d22e)) + +# [1.2.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.1.1...v1.2.0) (2020-05-12) + + +### Bug Fixes + +* **build:** include dependencies in the shadow jar ([803099b](https://github.com/Silthus/spigot-plugin-template/commit/803099bdf08c8a9a465d9d1323e3e65e1d498b7a)) + + +### Features + +* **build:** replace artifactory with github packages ([f83a08a](https://github.com/Silthus/spigot-plugin-template/commit/f83a08a3507345e234105cb46a1bcf0b9950816a)) +* **build:** target JDK 1.8 ([0cc380c](https://github.com/Silthus/spigot-plugin-template/commit/0cc380cc335780ebba57f46ad035badff6cfe299)) + +## [1.1.1](https://github.com/Silthus/spigot-plugin-template/compare/v1.1.0...v1.1.1) (2020-05-10) + + +### Bug Fixes + +* **build:** cache yarn.lock instead of package-lock ([c067aab](https://github.com/Silthus/spigot-plugin-template/commit/c067aab502cb076253232e20533449336e54fa15)) +* **lint:** remove spotless linting ([cb2f8d1](https://github.com/Silthus/spigot-plugin-template/commit/cb2f8d1e70081e414e6fbe76479d7a2387108070)) + +# [1.1.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.0.1...v1.1.0) (2020-05-09) + + +### Bug Fixes + +* **build:** use ubuntu-18.04 as build host ([38669f1](https://github.com/Silthus/spigot-plugin-template/commit/38669f1523270edfc35e57f3d0278a2cb976a00c)) +* **release:** add github credentials ([c6387b5](https://github.com/Silthus/spigot-plugin-template/commit/c6387b57e79260a55423c5a824353200c5ad1bbd)) + + +### Features + +* **publish:** publish artifact to github packages ([29afd59](https://github.com/Silthus/spigot-plugin-template/commit/29afd59e039142340e6ae52aa0dfd4d8891c78fc)) + +# [1.1.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.0.1...v1.1.0) (2020-05-09) + + +### Bug Fixes + +* **build:** use ubuntu-18.04 as build host ([38669f1](https://github.com/Silthus/spigot-plugin-template/commit/38669f1523270edfc35e57f3d0278a2cb976a00c)) +* **release:** add github credentials ([c6387b5](https://github.com/Silthus/spigot-plugin-template/commit/c6387b57e79260a55423c5a824353200c5ad1bbd)) + + +### Features + +* **publish:** publish artifact to github packages ([29afd59](https://github.com/Silthus/spigot-plugin-template/commit/29afd59e039142340e6ae52aa0dfd4d8891c78fc)) + +# [1.1.0](https://github.com/Silthus/spigot-plugin-template/compare/v1.0.1...v1.1.0) (2020-05-09) + + +### Bug Fixes + +* **build:** use ubuntu-18.04 as build host ([38669f1](https://github.com/Silthus/spigot-plugin-template/commit/38669f1523270edfc35e57f3d0278a2cb976a00c)) +* **release:** add github credentials ([c6387b5](https://github.com/Silthus/spigot-plugin-template/commit/c6387b57e79260a55423c5a824353200c5ad1bbd)) + + +### Features + +* **publish:** publish artifact to github packages ([29afd59](https://github.com/Silthus/spigot-plugin-template/commit/29afd59e039142340e6ae52aa0dfd4d8891c78fc)) + +## [1.1.1](https://github.com/Silthus/spigot-plugin-template/compare/v1.1.0...v1.1.1) (2020-05-08) + + +### Bug Fixes + +* **release:** add github credentials ([c6387b5](https://github.com/Silthus/spigot-plugin-template/commit/c6387b57e79260a55423c5a824353200c5ad1bbd)) + +# [1.1.0](https://github.com/mcSilthus/spigot-plugin-template/compare/v1.0.1...v1.1.0) (2020-05-08) + + +### Bug Fixes + +* **build:** use ubuntu-18.04 as build host ([38669f1](https://github.com/mcSilthus/spigot-plugin-template/commit/38669f1523270edfc35e57f3d0278a2cb976a00c)) + + +### Features + +* **publish:** publish artifact to github packages ([29afd59](https://github.com/mcSilthus/spigot-plugin-template/commit/29afd59e039142340e6ae52aa0dfd4d8891c78fc)) + +## [1.0.1](https://github.com/mcSilthus/spigot-plugin-template/compare/v1.0.0...v1.0.1) (2020-05-05) + + +### Bug Fixes + +* **release:** run gradle-release before github ([a3ef1fa](https://github.com/mcSilthus/spigot-plugin-template/commit/a3ef1fa22441879e8de6d27a8af0cd5f2ad581f9)) + +# 1.0.0 (2020-05-05) + + +### Bug Fixes + +* **gradle:** publish build artifacts to maven ([a997f81](https://github.com/mcSilthus/spigot-plugin-template/commit/a997f8196d7e58f2dbeea46a94f0584ef1be6593)) +* **release:** use node 12 for semantic-release ([88166a9](https://github.com/mcSilthus/spigot-plugin-template/commit/88166a91ec37f5fa86324137a45e07126a3072e0)) +* **test:** directly reference plugin.yml in test ([97f7fc4](https://github.com/mcSilthus/spigot-plugin-template/commit/97f7fc4956138cf83625026c7134d9fb1eaf3794)) +* plugin startup ([134f07f](https://github.com/mcSilthus/spigot-plugin-template/commit/134f07f22badfddfe8e924627a75ec68d3814978)) + + +### Features + +* **build:** add semantic versioning ([cdedcfd](https://github.com/mcSilthus/spigot-plugin-template/commit/cdedcfd8315309c030668421a4730a23f5282bec)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5cb7669 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,168 @@ +# Contributing Guidelines + +First off, thank you for considering contributing to this project. It's people like you that make this such a great plugin. + +Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. + +This is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the plugin itself. + +Please, don't use the issue tracker for [requesting new plugins](https://www.spigotmc.org/threads/open-small-to-medium-plugin-development-pay-what-you-want-8-years-experience-high-quality.435578/). Read the post on the Spigot board or send me a [email](mailto://me@silthus.net). + +# Ground Rules + +By contributing to this project you submit to following our [code of conduct](.github/CODE_OF_CONDUCT.md). +Please read this next section carefully and check if your contribution meets all requirements in this checklist. This will save you and us a lot of time. + +## Issues: Feature Requests & Bug Reports + +Please make sure you checked all of the following before submitting a new issue. + +* Before submitting a new issue, search the existing (including closed) issues for any duplicates. +* If you found an existing issue - use the react feature to show you have the same problem or need the same feature. Don't post comments like +1. +* Use the Bug & Feature Issue templates and provide all the required information. +* Be as detailed as possible and include screenshots wherever possible. This will help reproducing your bug or understanding your feature request. +* Use the WorldGuard `/wg report -p` command to provide detailed debug information and post the pastebin link in the issue. + +## Contributing Code + +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: + +* **Commit using the [conventional-commit](https://www.conventionalcommits.org/en/v1.0.0/) format!** +* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback. +* Keep feature versions as small as possible, preferably one new feature per version. +* Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. + +# Your First Contribution + +Unsure where to begin contributing to this project? You can start by looking through these beginner and help-wanted issues: +Good first issues - issues which should only require a few lines of code, and a test or two. +Help wanted issues - issues which should be a bit more involved than beginner issues. + +Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). + +At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat: + +If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge. + +# Getting started + +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs or added new features, update the documentation. +4. Ensure the test suite passes. +5. Test your changes on a server running the latest supported Minecraft version. +6. Issue that pull request! + +> You can use the `Setup Server` gradle task to quickly get your test server setup. Then use the `deploy` task to compile and copy your plugin.jar to the server. + +# Code review process + +The core team will look at your change as soon as possible and review it. However since this a project that is done in free time, reviewing might sometimes take some time. + +# Code, commit message and labeling conventions + +We have very precise rules over how our git commit messages can be formatted. This leads to **more +readable messages** that are easy to follow when looking through the **project history**. + +It is important to note that we use the git commit messages to **generate** the [CHANGELOG](CHANGELOG.md) document. Improperly formatted commit messages may result in your +change not appearing in the CHANGELOG of the next release. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +```html +(): + + + +