From 36b577c6020486759bf61a69a0ff2594417fdaca Mon Sep 17 00:00:00 2001 From: Daniel McCoy Stephenson Date: Tue, 3 Nov 2026 23:52:01 -0700 Subject: [PATCH] Say when the API check runs and who sees the console alert The README said every build checks Bukkit API use, but only the Build workflow does: mvn clean package, Dev Release and Release do not. It also said Build runs on every push, not just pushes to main, and left out the manual trigger that has republished dev three times since #30. The console alert is sent to any sender that is not a Player, so the user guide and command reference now say so. Co-Authored-By: Claude Opus 5.5 --- CHANGELOG.md | 1 + COMMANDS.md | 4 ++-- CONTRIBUTING.md | 2 +- README.md | 6 +++--- USER_GUIDE.md | 2 +- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 550f3b6..b1b514c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Fixed - `COMMANDS.md` now lists the exact messages `/fly` shows, including the permission-denied and console alerts, which the 1.0.0 entry below said it already did. +- `USER_GUIDE.md` and `COMMANDS.md` now say that the console alert is shown to any non-player sender, such as a command block, not only the server console. ## [1.0.0] - 2026-10-02 diff --git a/COMMANDS.md b/COMMANDS.md index 7952719..e9874c0 100644 --- a/COMMANDS.md +++ b/COMMANDS.md @@ -2,7 +2,7 @@ | Command | Permission | Description | |---------|------------|-------------| -| `/fly` | `FlyCommand.fly` | Toggles flight mode on or off for the executing player. Player-only; the console is rejected with an alert. Also available as `/flycommand:fly`, which reaches FlyCommand even if another plugin provides `/fly`. | +| `/fly` | `FlyCommand.fly` | Toggles flight mode on or off for the executing player. Player-only; the console and any other non-player sender, such as a command block, are rejected with an alert. Also available as `/flycommand:fly`, which reaches FlyCommand even if another plugin provides `/fly`. | ## `/fly` messages @@ -11,4 +11,4 @@ | Player with `FlyCommand.fly`, flight was off | `Flight enabled.` | Flight is allowed. | | Player with `FlyCommand.fly`, flight was on | `Flight disabled.` | Flight is disallowed. | | Player without `FlyCommand.fly` | `Alert: Permission 'FlyCommand.fly' required.` | Flight is unchanged. | -| Server console | `Alert: Can't be used by console.` | Nothing else happens. | +| Server console, or any other non-player sender such as a command block | `Alert: Can't be used by console.` | Nothing else happens. | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d86d65..a43d963 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Thank you for your interest in contributing! 1. Fork the repository. 2. Create a feature branch from `main`: `git checkout -b feature/my-change` 3. Make your changes. -4. Run `mvn clean package`, which compiles the plugin and runs its tests; the [Build](.github/workflows/build.yml) workflow runs the same command on your pull request. If you change how `/fly` behaves, also follow the README's [manual validation steps](README.md#manual-validation-on-a-test-server) on a test server. +4. Run `mvn clean package`, which compiles the plugin and runs its tests; the [Build](.github/workflows/build.yml) workflow runs the same command on your pull request, then checks the plugin's Bukkit API use against every version in [`minecraft-versions.json`](minecraft-versions.json), which `mvn clean package` does not do. If you change how `/fly` behaves, also follow the README's [manual validation steps](README.md#manual-validation-on-a-test-server) on a test server. 5. Open a pull request against `main`. 6. Reference the related GitHub issue in your pull request description. diff --git a/README.md b/README.md index c687fbf..a551ebd 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ FlyCommand is a Spigot plugin that lets permitted players toggle flight mode on and off with a single command. It adds one command, `/fly`, and nothing else — there is no configuration file and no persistent data. ## Supported Minecraft Versions -This plugin is supported on the Minecraft versions listed in [`minecraft-versions.json`](minecraft-versions.json): currently **1.19.4**, **1.21.11**, **26.2** and **26.3** (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and every build checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up. +This plugin is supported on the Minecraft versions listed in [`minecraft-versions.json`](minecraft-versions.json): currently **1.19.4**, **1.21.11**, **26.2** and **26.3** (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and the [Build](.github/workflows/build.yml) workflow checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up. ## Installation @@ -48,7 +48,7 @@ Please open a bug report [here](https://github.com/Dans-Plugins/FlyCommand/issue ## Testing -`mvn clean package` compiles the plugin and runs its test suite. The suite checks the `plugin.yml` packed into the jar: that `main` names the plugin class, that the build filled in the version, and that the `Fly` command and the `FlyCommand.fly` permission are declared. It also runs the `/fly` handler against stand-in senders, checking the toggle and its confirmations (including when the command is typed as `/flycommand:fly`), the permission-denied alert, and the console alert. The [Build](.github/workflows/build.yml) workflow runs the same command on every push and pull request. +`mvn clean package` compiles the plugin and runs its test suite. The suite checks the `plugin.yml` packed into the jar: that `main` names the plugin class, that the build filled in the version, and that the `Fly` command and the `FlyCommand.fly` permission are declared. It also runs the `/fly` handler against stand-in senders, checking the toggle and its confirmations (including when the command is typed as `/flycommand:fly`), the permission-denied alert, and the console alert. The [Build](.github/workflows/build.yml) workflow runs the same command on every push to `main` and every pull request against it, then the Bukkit API check described under [Supported Minecraft Versions](#supported-minecraft-versions), which `mvn clean package` does not run. The tests do not start a server, so the plugin loading and `/fly` being registered are still verified by hand on a Spigot or Paper server, as described under [Manual Validation](#manual-validation-on-a-test-server). @@ -72,7 +72,7 @@ The jar is written to `target/FlyCommand-.jar`. It is compiled for Java ### Releases -Every push to `main` that changes anything other than Markdown files or `LICENSE` republishes the rolling `dev` prerelease ([Dev Release](.github/workflows/dev-release.yml)). Stable releases are published from a verified `dev` build; a release published without a jar has one built and attached by [Release](.github/workflows/release.yml). +Every push to `main` that changes anything other than Markdown files or `LICENSE` republishes the rolling `dev` prerelease ([Dev Release](.github/workflows/dev-release.yml)); the workflow can also be run by hand, which republishes `dev` from whatever commit it is run on. Stable releases are published from a verified `dev` build; a release published without a jar has one built and attached by [Release](.github/workflows/release.yml). ### Manual Validation on a Test Server diff --git a/USER_GUIDE.md b/USER_GUIDE.md index d639819..7a62b1d 100644 --- a/USER_GUIDE.md +++ b/USER_GUIDE.md @@ -20,7 +20,7 @@ Type `/fly` to toggle your flight on or off. The plugin will confirm the new sta `/fly` can only be used by a player: -- Running it from the server console shows `Alert: Can't be used by console.` and does nothing else. +- Running it from the server console, or from anything else that is not a player, such as a command block, shows `Alert: Can't be used by console.` and does nothing else. - Running it as a player without the `FlyCommand.fly` permission shows `Alert: Permission 'FlyCommand.fly' required.` and leaves flight unchanged. ## Permissions